# 22vv0/asphyxia_plugins architecture

> Architecture diagram of the GitHub repository 22vv0/asphyxia_plugins, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/22vv0/asphyxia_plugins
- Repository: https://github.com/22vv0/asphyxia_plugins

## Overview

##### Project type and purpose
- This repository is not a traditional codebase but a distribution hub for “Asphyxia Plugins” (SOUND VOLTEX and DanceDanceRevolution). Its sole function is to package and deliver prebuilt plugin archives to end users, who then drop them into their game’s plugin folder.

##### File structure
- At the top level we only have:
- .gitignore – standard ignore rules
- .prettierrc – code style config (likely unused here)
- README.md – usage instructions and links to plugin releases
- There is no “src,” “lib,” or other code directories, indicating no build pipeline or backend service. All artifacts live in GitHub Releases.

##### README for additional insights
- Describes a manual workflow:
a. User visits Releases page on GitHub
b. Downloads chosen plugin ZIP
c. Extracts into a game’s plugin folder (folder name must match the savedata DB file)
- No mention of CI/CD, web services, or in‐repo build scripts.

##### Main components
a. GitHub (Repository + Releases)
b. End User (Admin or Player)
c. Archive File (ZIP)
d. Local File System (Game Plugin Folder)
e. Game Engine or Plugin Loader
f. Savedata DB file (ensures plugin is recognized)

##### Relationships and interactions
- User → GitHub Releases: “Download ZIP”
- ZIP → Local File System: “Extract into game/plugin folder”
- Local File System ↔ Savedata DB: “Naming convention ties plugin to DB”
- Game Engine → Local File System: “At launch, loads plugin .dll/.asi from folder”

##### Architectural patterns or design principles
- Distribution-only service (no dynamic backend)
- Simple “drop-in plugin” architecture
- Versioned releases on GitHub used as artifact repository

##### Relevant technologies
- GitHub Releases for artifact hosting
- ZIP file compression
- Game’s native plugin loader (e.g. .asi or .dll loader)
- (Optionally) any third-party unzip tool the user employs

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "GitHub Repo / Releases"
        Repo["GitHub Repository / Releases"]:::external
        README["README.md"]:::external
        Gitignore[".gitignore"]:::external
        Prettierrc[".prettierrc"]:::external
    end

    User["End User"]:::external
    Archive["Plugin Archive (ZIP)"]:::fs
    FS["Local File System / Plugin Folder"]:::fs
    DB["Savedata DB\n(Name must match plugin folder)"]:::fs
    Engine["Game Engine / Plugin Loader"]:::runtime

    User -->|"HTTP GET plugin.zip"| Repo
    Repo -->|"Download ZIP"| Archive
    Archive -->|"Extract & Extract"| FS
    FS -.->|"Naming constraint"| DB
    FS -->|"Load plugin on startup"| Engine

    click README "https://github.com/22vv0/asphyxia_plugins/blob/main/README.md"
    click Gitignore "https://github.com/22vv0/asphyxia_plugins/blob/main/.gitignore"
    click Prettierrc "https://github.com/22vv0/asphyxia_plugins/blob/main/.prettierrc"

    classDef external fill:#ADD8E6,stroke:#000
    classDef fs fill:#90EE90,stroke:#000
    classDef runtime fill:#FFA500,stroke:#000
```
