# aiyayayah/metroidvania-inspired-game architecture

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

- Interactive diagram: https://gitdiagram.com/aiyayayah/metroidvania-inspired-game
- Repository: https://github.com/aiyayayah/metroidvania-inspired-game

## Overview

##### Project type and purpose
- This is a standalone Unity 2D Metroidvania‐inspired game.
- It uses Unity’s core engine, custom C# MonoBehaviour scripts, third‐party tweening (DOTween), Spine animation exports, and a set of Scenes/Prefabs/Resources.

##### Top‐level components/subsystems
A. Unity Engine Core
- Scene Management
- Rendering Pipeline (2D Sprite Renderer + Shaders)
- Physics2D
- Input System
- Audio System
- Asset Pipeline & Resources
B. Game Logic (Custom Scripts under Assets/Scripts)
- Game Manager / Scene Controllers (GameStartButton, ExitGameButton)
- Player Controller (Player.cs, PlayerSkill1.cs, PlayerSkill2.cs, PlayerGetHit.cs, PlayerHPBar.cs)
- Enemy Controller (EnemyController.cs, EnemyAttack.cs, EnemyGetHit.cs, EnemyHPBar.cs)
- UI Controllers (Health bars, Skill effects, SoundButtonDown, SoundVolume)
- Attack/Skill Handlers (AttackBoxDestroy.cs, Skill1Destroy.cs)
C. Asset Modules
- Characters – Player & Wizard prefabs + animations (Spine & Unity‐baked)
- Enemies – Zombie & generic Enemy prefabs + animations
- Free Assets & VFX Libraries (2D Handcrafted Art, Lana Studio VFX)
- Audio Assets (SFX, BGM)
- Shaders (Spine‐Skeleton.shader, custom water & tile shaders)
- Plugins (DOTween)
D. Scenes
- StartScene: UI menu, GameStartButton → loads DemoScene or SampleScene
- SampleScene / DemoScene: main gameplay levels
E. ProjectSettings & Packages
- InputManager, AudioManager, Physics2DSettings → configures engine subsystems
- Packages/manifest.json → includes DOTween & other package dependencies

##### Relationships & interactions
- Input System → PlayerController & UI Controllers
- PlayerController / EnemyController ↔ Physics2D (colliders, rigidbodies)
- Game Manager → SceneManager (loads/unloads Scenes)
- MonoBehaviours (Player, Enemy, UI) → Asset Modules (Prefabs + Animations + Audio)
- DOTween plugin → tweening & animation sequences invoked by scripts
- Audio System → audio assets called by script events (attacks, hits, BGM loop)
- Resources (DOTweenSettings, Spine skeleton data) → loaded at runtime

##### Architectural patterns & principles
- Component‐based design: everything is a MonoBehaviour attached to a GameObject.
- Separation of concerns: Input → Controller → View/Prefab → Physics/Audio.
- Asset‐driven design: Scenes reference Prefabs, which bundle Meshes/Sprites, Animators, Scripts.
- Event‐driven interactions: UI button clicks fire events to GameStartButton, ExitGameButton, SoundButtonDown.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Unity Engine Core
    subgraph "Unity Engine Core"
        SM["Scene Manager"]:::engine
        RP["Rendering Pipeline"]:::engine
        PHY["Physics2D"]:::engine
        INP["Input System"]:::engine
        AUD["Audio System"]:::engine
        RL["Asset/Resources Loader"]:::engine
    end

    %% Game Logic Scripts
    subgraph "Game Logic Scripts"
        GSB["GameStartButton.cs"]:::scripts
        EXB["ExitGameButton.cs"]:::scripts
        PLY["Player.cs"]:::scripts
        PS1["PlayerSkill1.cs"]:::scripts
        PS2["PlayerSkill2.cs"]:::scripts
        PGH["PlayerGetHit.cs"]:::scripts
        PHB["PlayerHPBar.cs"]:::scripts
        EC["EnemyController.cs"]:::scripts
        EA["EnemyAttack.cs"]:::scripts
        EGH["EnemyGetHit.cs"]:::scripts
        EHB["EnemyHPBar.cs"]:::scripts
        ABD["AttackBoxDestroy.cs"]:::scripts
        S1D["Skill1Destroy.cs"]:::scripts
        SBD["SoundButtonDown.cs"]:::scripts
        SV["soundVolume.cs"]:::scripts
        MBD["MainButtonDown.cs"]:::scripts
    end

    %% Asset Modules
    subgraph "Asset Modules"
        CHAR["Character Assets"]:::assets
        WIZ["Wizard Assets"]:::assets
        ENM["Enemy Assets"]:::assets
        VFX["Free Art & VFX"]:::assets
        AUDAS["Audio Assets"]:::assets
        SHD["Shaders"]:::assets
    end

    %% Third-Party Plugins
    subgraph "Plugins"
        DWT["DOTween Plugin"]:::plugins
    end

    %% Scenes
    subgraph "Scenes"
        SS["StartScene.unity"]:::assets
        SaS["SampleScene.unity"]:::assets
        DS["DemoScene.unity"]:::assets
    end

    %% Resources Loader Details
    RT["DOTweenSettings.asset"]:::engine

    %% Project Settings
    subgraph "Project Settings"
        IM["InputManager.asset"]:::engine
        PS2["Physics2DSettings.asset"]:::engine
        AM["AudioManager.asset"]:::engine
    end

    %% Relationships
    INP -->|"OnInput()"| PLY
    INP -->|"OnInput()"| SBD
    PLY -->|"Move/Jump"| PHY
    EC -->|"CollisionCallback"| PHY
    PLY -->|"Render Update"| RP
    EC -->|"Render Update"| RP
    PLY -->|"Play SFX"| AUD
    EC -->|"Play SFX"| AUD
    GSB -->|"LoadScene()"| SM
    EXB -->|"ExitGame()"| SM
    PLY -->|"Load Prefab"| RL
    EC -->|"Load Prefab"| RL
    RL -->|"Load Settings"| RT
    SM -->|"Manage Scenes"| SS
    SM -->|"Manage Scenes"| SaS
    SM -->|"Manage Scenes"| DS
    PHY -->|"OnCollision()"| PLY
    PHY -->|"OnCollision()"| EC
    DWT -->|"Tween Calls"| PLY
    DWT -->|"Tween Calls"| EC

    %% Click Events for Scripts
    click GSB "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/GameStartButton.cs"
    click EXB "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/ExitGameButton.cs"
    click PLY "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/Player.cs"
    click PS1 "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/PlayerSkill1.cs"
    click PS2 "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/PlayerSkill2.cs"
    click PGH "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/PlayerGetHit.cs"
    click PHB "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/PlayerHPBar.cs"
    click EC "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/EnemyController.cs"
    click EA "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/EnemyAttack.cs"
    click EGH "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/EnemyGetHit.cs"
    click EHB "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/EnemyHPBar.cs"
    click ABD "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/AttackBoxDestroy.cs"
    click S1D "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/Skill1Destroy.cs"
    click SBD "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/SoundButtonDown.cs"
    click SV "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/soundVolume.cs"
    click MBD "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scripts/MainButtonDown.cs"

    %% Click Events for Assets
    click CHAR "https://github.com/aiyayayah/metroidvania-inspired-game/tree/main/Assets/Character"
    click WIZ "https://github.com/aiyayayah/metroidvania-inspired-game/tree/main/Assets/Wizard - 2D Character"
    click ENM "https://github.com/aiyayayah/metroidvania-inspired-game/tree/main/Assets/Enemy"
    click VFX "https://github.com/aiyayayah/metroidvania-inspired-game/tree/main/Assets/Free Asset - 2D Handcrafted Art"
    click AUDAS "https://github.com/aiyayayah/metroidvania-inspired-game/tree/main/Assets/Sound"
    click SHD "https://github.com/aiyayayah/metroidvania-inspired-game/tree/main/Assets/2D Zombie/Shader"

    %% Click Events for Plugins, Resources, Scenes, Settings
    click DWT "https://github.com/aiyayayah/metroidvania-inspired-game/tree/main/Assets/Plugins/Demigiant/DOTween/"
    click RT "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Resources/DOTweenSettings.asset"
    click SS "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scenes/StartScene.unity"
    click SaS "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scenes/SampleScene.unity"
    click DS "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/Assets/Scenes/DemoScene.unity"
    click IM "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/ProjectSettings/InputManager.asset"
    click PS2 "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/ProjectSettings/Physics2DSettings.asset"
    click AM "https://github.com/aiyayayah/metroidvania-inspired-game/blob/main/ProjectSettings/AudioManager.asset"

    %% Styles
    classDef engine fill:#cce5ff,stroke:#80bfff,color:#004080
    classDef scripts fill:#e6ffe6,stroke:#80ff80,color:#006600
    classDef assets fill:#ffffcc,stroke:#ffff80,color:#666600
    classDef plugins fill:#ffe6cc,stroke:#ffb366,color:#804000
```
