# jelmerta/kloenk architecture

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

- Interactive diagram: https://gitdiagram.com/jelmerta/kloenk
- Repository: https://github.com/jelmerta/kloenk

## Overview

##### Main Components

a) Client-Side Core Components:
- Render System (prominently featured in /src/render/)
- State Management System (from /src/state/)
- Game Systems (from /src/systems/)
- Resource Management (from /src/resources.rs)

b) Platform Targets:
- Web Platform (WASM)
- Native Platform (Windows/Linux)

##### Architectural Layers (from bottom to top)

Layer 1 - Core Engine:
- RenderContext Manager as the primary interface to graphics
- Material, Model, and Texture managers

Layer 2 - Game Systems:
- Related systems into logical clusters:
- World Systems (Collision, Position, Movement)
- Interaction Systems (Object Detection, Selection, Item Pickup)
- UI Systems (Dialogue, Chat, Inventory)
- Audio System

Layer 3 - State Management:
- GameState as the central state container
- FrameState, UIState, and Input components
- State flow between systems

Layer 4 - Application Layer:
- Main Application container
- GUI and CursorManager
- Platform-specific bindings (WASM/Native)

##### Important Relationships to Highlight

- Blue: Render-related components
- Green: Game logic systems
- Yellow: State management
- Purple: Platform-specific code

Top Section:
**[Web Browser] ←→ [WASM Bundle] ↔ [Application Core]**
- ↓
**[WebGPU API]**

Middle Section:
**[Game Systems] ←→ [State Management] ←→ [Render Pipeline]**
- ↓               ↓                      ↓
**[Component Managers] [Frame State] [Graphics Resources]**

Bottom Section:
**[Asset Loading] → [Resource Management] → [Memory Management]**

##### Technical Details

- WebGPU as the primary graphics API
- WASM compilation pathway
- Where shaders (WGSL) are utilized
- System communication patterns

## Diagram (Mermaid)

```mermaid
graph TB
    %% Platform Layer
    subgraph PlatformLayer["Platform Layer"]
        WebBrowser["Web Browser"]
        WasmBundle["WASM Bundle"]
        NativeBinary["Native Binary"]
        WebGPU["WebGPU API"]
    end

    %% Application Layer
    subgraph AppLayer["Application Layer"]
        App["Application"]:::app
        GUI["GUI System"]:::ui
        CursorMgr["Cursor Manager"]:::ui
    end

    %% State Management Layer
    subgraph StateLayer["State Management"]
        GameState["Game State"]:::state
        FrameState["Frame State"]:::state
        UIState["UI State"]:::state
        InputMgr["Input Manager"]:::state
    end

    %% Game Systems Layer
    subgraph SystemsLayer["Game Systems"]
        direction TB
        SystemsMgr["Systems Manager"]:::system

        subgraph WorldSystems["World Systems"]
            CollisionMgr["Collision Manager"]:::system
            PositionMgr["Position Manager"]:::system
            MovementSys["Movement System"]:::system
        end

        subgraph InteractionSystems["Interaction Systems"]
            ObjectDetection["Object Detection"]:::system
            ObjectSelection["Object Selection"]:::system
            ItemPickup["Item Pickup"]:::system
        end

        subgraph UISystems["UI Systems"]
            DialogueSys["Dialogue System"]:::system
            ChatSys["Chat System"]:::system
            InventorySys["Inventory System"]:::system
        end

        AudioSys["Audio System"]:::system
    end

    %% Render Layer
    subgraph RenderLayer["Render Layer"]
        RenderContext["Render Context Manager"]:::render
        MaterialMgr["Material Manager"]:::render
        ModelMgr["Model Manager"]:::render
        TextureMgr["Texture Manager"]:::render
        CameraMgr["Camera Manager"]:::render
        ShaderSys["Shader System"]:::render
    end

    %% Resource Management Layer
    subgraph ResourceLayer["Resource Management"]
        ResourceSys["Resource System"]:::resource
        AssetLoader["Asset Loader"]:::resource
    end

    %% Relationships
    WebBrowser --> WasmBundle
    WasmBundle --> App
    NativeBinary --> App
    App --> WebGPU

    App --> GUI
    App --> CursorMgr
    App --> GameState

    GameState --> FrameState
    GameState --> UIState
    GameState --> InputMgr

    SystemsMgr --> GameState
    WorldSystems --> SystemsMgr
    InteractionSystems --> SystemsMgr
    UISystems --> SystemsMgr
    AudioSys --> SystemsMgr

    RenderContext --> WebGPU
    MaterialMgr --> RenderContext
    ModelMgr --> RenderContext
    TextureMgr --> RenderContext
    CameraMgr --> RenderContext
    ShaderSys --> RenderContext

    ResourceSys --> AssetLoader
    AssetLoader --> RenderContext
    AssetLoader --> AudioSys

    %% Styles
    classDef app fill:#f9f,stroke:#333
    classDef ui fill:#fcf,stroke:#333
    classDef state fill:#ff9,stroke:#333
    classDef system fill:#9f9,stroke:#333
    classDef render fill:#99f,stroke:#333
    classDef resource fill:#f99,stroke:#333

    %% Click Events
    click App "https://github.com/Jelmerta/Kloenk/blob/main/src/application.rs"
    click GUI "https://github.com/Jelmerta/Kloenk/blob/main/src/gui.rs"
    click CursorMgr "https://github.com/Jelmerta/Kloenk/blob/main/src/cursor_manager.rs"
    click GameState "https://github.com/Jelmerta/Kloenk/blob/main/src/state/game_state.rs"
    click FrameState "https://github.com/Jelmerta/Kloenk/blob/main/src/state/frame_state.rs"
    click UIState "https://github.com/Jelmerta/Kloenk/blob/main/src/state/ui_state.rs"
    click InputMgr "https://github.com/Jelmerta/Kloenk/blob/main/src/state/input.rs"
    click CollisionMgr "https://github.com/Jelmerta/Kloenk/blob/main/src/systems/collision_manager.rs"
    click PositionMgr "https://github.com/Jelmerta/Kloenk/blob/main/src/systems/position_manager.rs"
    click MovementSys "https://github.com/Jelmerta/Kloenk/blob/main/src/systems/movement_system.rs"
    click ObjectDetection "https://github.com/Jelmerta/Kloenk/blob/main/src/systems/object_detection_system.rs"
    click ObjectSelection "https://github.com/Jelmerta/Kloenk/blob/main/src/systems/object_selection_system.rs"
    click ItemPickup "https://github.com/Jelmerta/Kloenk/blob/main/src/systems/item_pickup_system.rs"
    click DialogueSys "https://github.com/Jelmerta/Kloenk/blob/main/src/systems/dialogue_system.rs"
    click ChatSys "https://github.com/Jelmerta/Kloenk/blob/main/src/systems/chat_system.rs"
    click InventorySys "https://github.com/Jelmerta/Kloenk/blob/main/src/systems/inventory_system.rs"
    click AudioSys "https://github.com/Jelmerta/Kloenk/blob/main/src/systems/audio_system.rs"
    click RenderContext "https://github.com/Jelmerta/Kloenk/blob/main/src/render/render_context_manager.rs"
    click MaterialMgr "https://github.com/Jelmerta/Kloenk/blob/main/src/render/material_manager.rs"
    click ModelMgr "https://github.com/Jelmerta/Kloenk/blob/main/src/render/model_manager.rs"
    click TextureMgr "https://github.com/Jelmerta/Kloenk/blob/main/src/render/texture.rs"
    click CameraMgr "https://github.com/Jelmerta/Kloenk/blob/main/src/render/camera_manager.rs"
    click ShaderSys "https://github.com/Jelmerta/Kloenk/tree/main/src/render/shaders/"
    click ResourceSys "https://github.com/Jelmerta/Kloenk/blob/main/src/resources.rs"
```
