# o-y/realm architecture

> Architecture diagram of the GitHub repository o-y/realm, 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/o-y/realm
- Repository: https://github.com/o-y/realm

## Overview

##### Main System Components

a) Client-Side (Frontend)
- Vue.js Application Layer
- Game Engine Layer (Phaser)
- Core Systems:
- Atlas System (world coordinates/bounds)
- Prometheus System (avatar/character management)
- Realm Generation System
- Tile Management System

b) Network/Communication Layer
- Supabase Integration
- Metered Video Call System
- Peer-to-Peer Communications

c) Server-Side Components
- Supabase Backend Services
- Authentication Services
- Database Services

##### Key Relationships to Highlight

a) Core Game Systems:
**[Atlas Service] ←→ [Realm Generator]**
- ↓
**[Tile System] ←→ [Layer Manager]**
- ↓
**[Prometheus System (Avatar Management)]**
- ↓
**[Phaser Scene Renderer]**

b) Communication Flow:
**[Client] ←→ [Supabase] ←→ [Database]**
- ↕
**[Peer Connection Manager]**
- ↕
**[Video Meeting System]**

##### Implementation Details

Key implementation aspects:

a) World Generation Pipeline:
**[Perlin Noise Generator] → [Realm Generator] → [Terrain Manager]**
- ↓
**[Gaia/Minos Map Generators]**

b) Avatar System:
**[Sprite Management] → [Animation System] → [Avatar Renderer]**
- ↓
**[Local/Remote Avatar Controllers]**

##### Technical Stack Indicators

- Vue.js
- TypeScript
- Phaser
- Supabase
- WebRTC (Metered)

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Client
        subgraph GameEngine["Game Engine Layer"]
            Scene["Phaser Scene Renderer"]:::engine
            Atlas["Atlas Service"]:::engine
            Prometheus["Prometheus System"]:::engine
            RealmGen["Realm Generator"]:::gen
            TileSystem["Tile System"]:::gen
            LayerMgr["Layer Manager"]:::gen
        end

        subgraph WorldGen["World Generation"]
            Perlin["Perlin Noise Generator"]:::gen
            Gaia["Gaia Map Generator"]:::gen
            Minos["Minos Map Generator"]:::gen
        end

        subgraph AvatarSystem["Avatar Management"]
            SpriteMgr["Sprite Manager"]:::avatar
            AnimSystem["Animation System"]:::avatar
            LocalAvatar["Local Avatar Controller"]:::avatar
        end

        subgraph Communication["Communication Layer"]
            Supabase["Supabase Client"]:::comm
            PeerMgr["Peer Connection Manager"]:::comm
            Video["Video Meeting System"]:::comm
            DB["Database Plugin"]:::comm
        end
    end

    %% Core Game Flow
    Atlas --> RealmGen
    RealmGen --> TileSystem
    TileSystem --> LayerMgr
    LayerMgr --> Scene

    %% World Generation Flow
    Perlin --> RealmGen
    Gaia --> RealmGen
    Minos --> RealmGen

    %% Avatar System Flow
    SpriteMgr --> AnimSystem
    AnimSystem --> Prometheus
    LocalAvatar --> Prometheus
    Prometheus --> Scene

    %% Communication Flow
    Supabase <--> PeerMgr
    PeerMgr <--> Video
    Supabase <--> DB

    %% Styling
    classDef engine fill:#3498db
    classDef gen fill:#e67e22
    classDef avatar fill:#9b59b6
    classDef comm fill:#2ecc71

    %% Click Events
    click Atlas "https://github.com/o-y/realm/blob/main/client/src/base/atlas/AtlasService.ts"
    click Prometheus "https://github.com/o-y/realm/tree/main/client/src/base/prometheus/"
    click RealmGen "https://github.com/o-y/realm/blob/main/client/src/base/gen/realms/internal/RealmGenerator.ts"
    click TileSystem "https://github.com/o-y/realm/blob/main/client/src/base/tile/internal/TileProvider.ts"
    click Supabase "https://github.com/o-y/realm/blob/main/client/src/base/supabase/SupabaseSingleton.ts"
    click Video "https://github.com/o-y/realm/blob/main/client/src/framework/metered/MeteredSingleton.ts"
    click PeerMgr "https://github.com/o-y/realm/blob/main/client/src/base/supabase/peer/PeerConnectionManager.ts"
    click Perlin "https://github.com/o-y/realm/blob/main/client/src/base/gen/perlin/PerlinNoise.ts"
    click Gaia "https://github.com/o-y/realm/blob/main/client/src/base/gen/realms/pipelines/gaia/GaiaMapGenerator.ts"
    click Minos "https://github.com/o-y/realm/blob/main/client/src/base/gen/realms/pipelines/minos/MinosMapGenerator.ts"
    click SpriteMgr "https://github.com/o-y/realm/blob/main/client/src/base/prometheus/sprite/manager/SpriteManager.ts"
    click AnimSystem "https://github.com/o-y/realm/blob/main/client/src/base/prometheus/sprite/animation/SpriteAnimationPlayer.ts"
    click LocalAvatar "https://github.com/o-y/realm/blob/main/client/src/base/prometheus/local/LocalAvatarController.ts"
    click LayerMgr "https://github.com/o-y/realm/blob/main/client/src/base/layer/LayerManager.ts"
    click Scene "https://github.com/o-y/realm/blob/main/client/src/base/scenes/PhaserWorldGenScene.ts"
    click DB "https://github.com/o-y/realm/blob/main/client/src/base/supabase/database/DatabasePlugin.ts"
```
