# gnurou/awer architecture

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

- Interactive diagram: https://gitdiagram.com/gnurou/awer
- Repository: https://github.com/gnurou/awer

## Overview

##### Component Details

a) Graphics System (most complex part):
- Three rendering paths:
- Software Renderer (src/gfx/sw)
- OpenGL3 Renderer (src/gfx/gl3)
- SDL2 Canvas Renderer (src/gfx/sdl2)
- Specialized renderers:
- Polygon Renderer
- Bitmap Renderer
- Font Renderer

b) Virtual Machine:
- Connection to resource management
- Bytecode interpreter (src/vm/ops.rs)
- Game state management

c) Audio System:
- Split into:
- Music handling (src/audio/music.rs)
- Sound effects
- SDL2 audio backend

d) Input System:
- Input handling through SDL2
- To main game loop

##### Data Flow Representation

- Resource loading path: Resource Files → Resource Manager → VM
- Rendering pipeline: VM → Game Renderer → Display
- Input flow: SDL2 Input → Input Manager → VM
- Audio processing: VM → Audio System → Sound Output

##### Technical Details

- Different rendering modes:
- Raster mode (320x200)
- OpenGL polygon rendering
- OpenGL line rendering
- Snapshot/state management system
- Resource management for game assets

##### Architectural Patterns to Highlight

- Component-based architecture
- Plugin-style rendering backend system
- Resource management system
- State management for game scenes

##### The resource management system's interaction with other components

Keep the abstraction level high enough to show the overall architecture while including enough detail to understand the different rendering paths and component interactions. This balance is crucial for this specific project due to its focus on both maintaining original game authenticity and supporting modern rendering capabilities.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Input
        InputHandler["Input Handler"]:::input
        SDL2Input["SDL2 Input System"]:::sdl
        InputHandler --> SDL2Input
    end

    subgraph Core
        MainEngine["Main Engine"]:::core
        SysManagement["System Management"]:::core
        ResManagement["Resource Management"]:::core
        SceneManagement["Scene Management"]:::core
        StringHandler["String Handler"]:::core
        
        MainEngine --> SysManagement
        MainEngine --> ResManagement
        MainEngine --> SceneManagement
        MainEngine --> StringHandler
    end

    subgraph "Graphics System"
        GfxInterface["Graphics Interface"]:::graphics
        
        subgraph "Renderers"
            SWRenderer["Software Renderer"]:::renderer
            GL3Renderer["OpenGL3 Renderer"]:::renderer
            SDL2Renderer["SDL2 Renderer"]:::renderer
        end
        
        subgraph "OpenGL3 Components"
            BitmapRenderer["Bitmap Renderer"]:::gl3
            PolyRenderer["Polygon Renderer"]:::gl3
            FontRendererGL["Font Renderer GL3"]:::gl3
            RasterRenderer["Raster Renderer"]:::gl3
            
            GL3Renderer --> BitmapRenderer
            GL3Renderer --> PolyRenderer
            GL3Renderer --> FontRendererGL
            GL3Renderer --> RasterRenderer
        end
        
        GameRenderer["Game Renderer"]:::graphics
        FontRenderer["Font Renderer"]:::graphics
        PolygonHandler["Polygon Handler"]:::graphics
        
        GfxInterface --> SWRenderer
        GfxInterface --> GL3Renderer
        GfxInterface --> SDL2Renderer
        GfxInterface --> GameRenderer
        GfxInterface --> FontRenderer
        GfxInterface --> PolygonHandler
    end

    subgraph "Audio System"
        AudioInterface["Audio Interface"]:::audio
        MusicHandler["Music Handler"]:::audio
        SDL2Audio["SDL2 Audio Backend"]:::sdl
        
        AudioInterface --> MusicHandler
        AudioInterface --> SDL2Audio
    end

    subgraph "Virtual Machine"
        VMCore["VM Core"]:::vm
        BytecodeInterpreter["Bytecode Interpreter"]:::vm
        
        VMCore --> BytecodeInterpreter
    end

    subgraph "SDL2 Platform"
        SDL2Sys["SDL2 System"]:::sdl
        SDL2Graphics["SDL2 Graphics"]:::sdl
        SDL2OpenGL["SDL2 OpenGL"]:::sdl
        
        SDL2Sys --> SDL2Graphics
        SDL2Sys --> SDL2OpenGL
    end

    %% Core System Connections
    MainEngine --> VMCore
    VMCore --> GfxInterface
    VMCore --> AudioInterface
    InputHandler --> VMCore
    ResManagement --> VMCore

    %% Style Definitions
    classDef core fill:#3498db
    classDef graphics fill:#2ecc71
    classDef audio fill:#f1c40f
    classDef input fill:#9b59b6
    classDef vm fill:#e67e22
    classDef sdl fill:#95a5a6
    classDef renderer fill:#27ae60
    classDef gl3 fill:#16a085

    %% Click Events
    click MainEngine "https://github.com/Gnurou/awer/blob/master/src/main.rs"
    click SysManagement "https://github.com/Gnurou/awer/tree/master/src/sys/"
    click ResManagement "https://github.com/Gnurou/awer/blob/master/src/res.rs"
    click SceneManagement "https://github.com/Gnurou/awer/blob/master/src/scenes.rs"
    click StringHandler "https://github.com/Gnurou/awer/blob/master/src/strings.rs"
    click GfxInterface "https://github.com/Gnurou/awer/blob/master/src/gfx.rs"
    click SWRenderer "https://github.com/Gnurou/awer/tree/master/src/gfx/sw/"
    click GL3Renderer "https://github.com/Gnurou/awer/tree/master/src/gfx/gl3/"
    click SDL2Renderer "https://github.com/Gnurou/awer/tree/master/src/gfx/sdl2/"
    click PolygonHandler "https://github.com/Gnurou/awer/blob/master/src/gfx/polygon.rs"
    click FontRenderer "https://github.com/Gnurou/awer/blob/master/src/font.rs"
    click GameRenderer "https://github.com/Gnurou/awer/blob/master/src/gfx/game_renderer.rs"
    click BitmapRenderer "https://github.com/Gnurou/awer/blob/master/src/gfx/gl3/game_renderer/programs/bitmap_renderer.rs"
    click PolyRenderer "https://github.com/Gnurou/awer/blob/master/src/gfx/gl3/game_renderer/programs/poly_renderer.rs"
    click FontRendererGL "https://github.com/Gnurou/awer/blob/master/src/gfx/gl3/game_renderer/programs/font_renderer.rs"
    click RasterRenderer "https://github.com/Gnurou/awer/blob/master/src/gfx/gl3/raster_renderer.rs"
    click AudioInterface "https://github.com/Gnurou/awer/blob/master/src/audio.rs"
    click MusicHandler "https://github.com/Gnurou/awer/blob/master/src/audio/music.rs"
    click SDL2Audio "https://github.com/Gnurou/awer/blob/master/src/audio/sdl2.rs"
    click InputHandler "https://github.com/Gnurou/awer/blob/master/src/input.rs"
    click VMCore "https://github.com/Gnurou/awer/blob/master/src/vm.rs"
    click BytecodeInterpreter "https://github.com/Gnurou/awer/blob/master/src/vm/ops.rs"
    click SDL2Sys "https://github.com/Gnurou/awer/tree/master/src/sys/sdl2/"
    click SDL2Graphics "https://github.com/Gnurou/awer/blob/master/src/gfx/sdl2/canvas_gfx.rs"
    click SDL2OpenGL "https://github.com/Gnurou/awer/blob/master/src/gfx/sdl2/gl3_gfx.rs"
```
