# vinceright3/warriorrpg architecture

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

- Interactive diagram: https://gitdiagram.com/vinceright3/warriorrpg
- Repository: https://github.com/vinceright3/warriorrpg

## Overview

##### Project type and purpose
- This is an Unreal Engine 5 action‑RPG game (“WarriorRPG”) composed of:
- A C++ game module (Source/Warrior) implementing gameplay, AI, UI, ability system, input, etc.
- A massive Content folder with maps, Blueprints, animation assets, materials, sounds, UI widgets, DataAssets, Niagara FX, etc.
- Configuration files for engine and game defaults.
- Purpose: a hero‑vs‑enemies survival mode with combat abilities, waves of enemies, boss fights, UI overlays, and editor tooling.

##### File structure
- Top‑level:
- Config: runtime ini configurations (engine, input, gameplay tags).
- Content: all game assets organized by function (Heroes, Enemies, Materials, Niagara, Sounds, UI Widgets, Maps, GameplayCues, Items, Blueprints, etc.).
- Source: C++ module “Warrior” (Public/Private folders) plus build scripts (.Build.cs, Target.cs).
- .uproject: UE project definition.
- Patterns and subsystems:
- AI: Behavior Trees, Services, Tasks under EnemyCharacter/… and C++ controllers/BTService/BTTask.
- Ability System: GameplayAbilities, GameplayEffects, AttributeSets under both C++ (AbilitySystem folder) and Content/EnemyCharacter/GameplayAbility.
- AnimInstances & Montages: separate layers for hero and enemies, C++ anim classes + assets.
- UI: UMG widgets in Content/Widgets + C++ UI components.
- Input: DataAssets + C++ InputComponent + InputAction assets.
- GameModes & GameInstance: survival and menu modes in Content/GameModes + C++ GameMode classes + GameInstance.
- Shared code: interfaces, base classes in Shared folder.

##### README for additional insights
- Confirms UE5 usage, proprietary code by author.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Editor and Packaging
    Editor["Editor/Packaging"]:::process
    Cooked["Cooked Content"]:::process
    Editor -->|cook assets| Cooked
    Cooked -->|loads at runtime| EngineCore

    %% Engine Core
    subgraph "Engine Core" 
        Rendering["Rendering"]:::engine
        Physics["Physics"]:::engine
        Audio["Audio"]:::engine
        InputSys["Input"]:::engine
        AIEngine["AI"]:::engine
        Networking["Networking"]:::engine
    end
    EngineCore["Unreal Engine 5 Core"]:::engine
    EngineCore --> Rendering
    EngineCore --> Physics
    EngineCore --> Audio
    EngineCore --> InputSys
    EngineCore --> AIEngine
    EngineCore --> Networking

    %% Game Module
    subgraph "Warrior Module (C++ Code)" 
        subgraph "Input Subsystem" 
            InputComp["WarriorInputComponent"]:::code
            DataAssetInput["Input DataAsset"]:::asset
        end
        subgraph "Gameplay Subsystem"
            AbilitySysComp["AbilitySystemComponent"]:::code
            AttributeSet["AttributeSet"]:::code
            CharacterPawn["Hero/Enemy Character Pawn"]:::code
        end
        subgraph "AI Subsystem"
            AIController["AIController"]:::code
            BehaviorTree["BehaviorTree Services/Tasks"]:::asset
        end
        subgraph "UI Subsystem"
            UIComp["HeroUIComponent\nEnemyUIComponent\nPawnUIComponent"]:::code
            Widgets["UMG Widgets"]:::asset
        end
        subgraph "GameFlow"
            GameMode["GameModes"]:::code
            GameInstance["GameInstance"]:::code
            WaveData["EnemyWave DataAsset"]:::asset
        end
        subgraph "Character & Animation"
            Characters["Character Classes"]:::code
            AnimInstances["AnimInstances & Montages"]:::asset
        end
        subgraph "Combat Components"
            CombatComp["Combat Components"]:::code
        end
        subgraph "Controllers"
            HeroCtrl["HeroController"]:::code
            AICharCtrl["EnemyAIController"]:::asset
        end
        subgraph "Data-Driven Startup Data"
            StartupData["StartUp DataAssets"]:::asset
        end
        subgraph "Items & PickUps"
            ItemsComp["PickUps & Items"]:::code
            StoneAssets["Stone Blueprints & Effects"]:::asset
        end
        subgraph "SaveGame"
            SaveGameComp["SaveGame"]:::code
        end
        subgraph "Shared Interfaces & Utilities"
            SharedIntf["Interfaces & Utilities"]:::code
            SharedAssets["Shared Blueprints"]:::asset
        end
    end

    %% Content Assets
    subgraph "Content Assets" 
        CharactersAssets["Characters & Animations"]:::asset
        Materials["Materials & Textures"]:::asset
        Niagara["Niagara FX"]:::asset
        Sounds["Sounds & Music"]:::asset
        UIWidgets["UI Widgets (UMG)"]:::asset
        Maps["Maps"]:::asset
        DataAssets["DataAssets & GameplayCues"]:::asset
    end

    %% Data Flows
    InputSys -->|DispatchInputAction| InputComp
    DataAssetInput -->|configures| InputComp
    InputComp -->|InvokeAbility| AbilitySysComp
    AbilitySysComp -->|ApplyGameplayEffect| AttributeSet
    AbilitySysComp -->|Affect| CharacterPawn
    AIEngine -->|RunBehaviorTree| BehaviorTree
    AIController -->|Control| CharacterPawn
    CharacterPawn -->|BindState| UIComp
    UIComp -->|Update| Widgets
    GameMode -->|SpawnWaves| WaveData
    WaveData -->|Use Startup Data| StartupData
    GameInstance -->|Manage| GameMode
    CombatComp -->|Handle| CharacterPawn
    ItemsComp -->|SpawnPickUp| StoneAssets
    SaveGameComp -->|Save/Load| GameInstance
    SharedIntf -->|Interface| CombatComp
    EngineCore -->|Render| Rendering
    EngineCore -->|Play| Audio
    AssetsLoaded((Assets Loaded)) 
    Cooked -->|provide| AssetsLoaded
    AssetsLoaded -->|used by| EngineCore

    %% Click Events
    click AIController "https://github.com/vinceright3/warriorrpg/tree/main/Source/Warrior/Private/Controllers"
    click BehaviorTree "https://github.com/vinceright3/warriorrpg/tree/main/Content/EnemyCharacter/BTService"
    click InputComp "https://github.com/vinceright3/warriorrpg/blob/main/Source/Warrior/Private/Components/Input/WarriorInputComponent.cpp"
    click DataAssetInput "https://github.com/vinceright3/warriorrpg/blob/main/Source/Warrior/Private/DataAssets/Input/DataAsset_InputConfig.cpp"
    click AbilitySysComp "https://github.com/vinceright3/warriorrpg/tree/main/Source/Warrior/Private/AbilitySystem"
    click UIComp "https://github.com/vinceright3/warriorrpg/tree/main/Source/Warrior/Private/Components/UI"
    click Widgets "https://github.com/vinceright3/warriorrpg/tree/main/Content/Widgets"
    click GameMode "https://github.com/vinceright3/warriorrpg/tree/main/Source/Warrior/Private/GameModes"
    click GameInstance "https://github.com/vinceright3/warriorrpg/blob/main/Source/Warrior/Private/WarriorGameInstance.cpp"
    click WaveData "https://github.com/vinceright3/warriorrpg/tree/main/Content/GameModes"
    click Characters "https://github.com/vinceright3/warriorrpg/tree/main/Source/Warrior/Private/Characters"
    click AnimInstances "https://github.com/vinceright3/warriorrpg/tree/main/Source/Warrior/Private/AnimInstances"
    click CombatComp "https://github.com/vinceright3/warriorrpg/tree/main/Source/Warrior/Private/Components/Combat"
    click HeroCtrl "https://github.com/vinceright3/warriorrpg/tree/main/Source/Warrior/Private/Controllers"
    click AICharCtrl "https://github.com/vinceright3/warriorrpg/tree/main/Content/EnemyCharacter"
    click StartupData "https://github.com/vinceright3/warriorrpg/tree/main/Source/Warrior/Private/DataAssets/StartUpData"
    click ItemsComp "https://github.com/vinceright3/warriorrpg/tree/main/Source/Warrior/Private/Items/PickUps"
    click StoneAssets "https://github.com/vinceright3/warriorrpg/tree/main/Content/Items/Stones"
    click SaveGameComp "https://github.com/vinceright3/warriorrpg/blob/main/Source/Warrior/Private/SaveGame/WarriorSaveGame.cpp"
    click SharedIntf "https://github.com/vinceright3/warriorrpg/tree/main/Source/Warrior/Private/Interfaces"
    click SharedAssets "https://github.com/vinceright3/warriorrpg/tree/main/Content/Shared"

    %% Styles
    classDef engine fill:#cccccc,stroke:#333,stroke-width:1px
    classDef code fill:#87CEEB,stroke:#0366d6,stroke-width:1px
    classDef asset fill:#98FB98,stroke:#228B22,stroke-width:1px
    classDef process fill:#FFD700,stroke:#DAA520,stroke-width:1px
```
