# joseluis2g/opinionatedforgottenserver architecture

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

- Interactive diagram: https://gitdiagram.com/joseluis2g/opinionatedforgottenserver
- Repository: https://github.com/joseluis2g/opinionatedforgottenserver

## Overview

##### Main Components Overview

a) Client Interface Layer
- Protocol handlers (src/protocol*.cpp files)
- Network message handling (src/networkmessage.cpp)
- Connection management (src/connection.cpp)

b) Game Logic Layer
- Core game engine (src/game.cpp)
- Combat system (src/combat.cpp)
- Scripting engine (src/luascript.cpp)
- Event handling (src/events.cpp)

c) World Management Layer
- System (src/map.cpp)
- Creature management (src/creature.cpp)
- Item handling (src/items.cpp)
- Spawn system (src/spawn.cpp)

d) Data Storage Layer
- Database management (src/database.cpp)
- Serialization (src/iomapserialize.cpp)
- Player data handling (src/iologindata.cpp)

##### Component Relationships
- Data flow (→): e.g., Client requests → Protocol handlers → Game Logic
- Dependencies (⇢): e.g., Game Logic ⇢ Database
- Event flow (⇨): e.g., Game Events ⇨ Script Engine

##### Specific Elements

a) Network Layer:
- [Client] ←→ [Protocol Handler] ←→ [Network Message Processor]
- ↓
- [Login Protocol] [Game Protocol] [Status Protocol]

b) Core Systems:
- [Game Engine]
- ↓
- [Map] [Combat] [Items] [Creatures]
- ↓
- [Event Manager] ←→ [Script Engine]

c) Data Management:
- [Database Manager]
- ↓
- [Map Storage] [Player Data] [House System]

##### Implementation Details
- Use rectangles for major components
- Use hexagons for interface points
- Notes for critical configurations and dependencies

##### Additional Elements
- Configuration management system
- Task scheduler system
- Security components (RSA, XTEA)
- Monster/NPC AI systems

## Diagram (Mermaid)

```mermaid
graph TB
    %% Define styles
    classDef network fill:#a8d1f0,stroke:#333
    classDef gamelogic fill:#90EE90,stroke:#333
    classDef storage fill:#FFE5B4,stroke:#333
    classDef security fill:#FFB6C1,stroke:#333
    classDef script fill:#DDA0DD,stroke:#333

    subgraph Client["Client Interface Layer"]
        Protocol["Protocol Handlers"]
        Network["Network Message"]
        Connection["Connection Manager"]
        
        Protocol --> Network
        Network --> Connection
    end

    subgraph GameLogic["Game Logic Layer"]
        GameEngine["Game Engine"]
        Combat["Combat System"]
        ScriptEngine["Script Engine"]
        EventHandler["Event Handler"]
        
        GameEngine --> Combat
        GameEngine --> ScriptEngine
        GameEngine --> EventHandler
        EventHandler --> ScriptEngine
    end

    subgraph World["World Management Layer"]
        MapSystem["Map System"]
        Creatures["Creature Manager"]
        Items["Item Handler"]
        Spawn["Spawn System"]
        
        MapSystem --> Creatures
        MapSystem --> Items
        MapSystem --> Spawn
    end

    subgraph Storage["Data Storage Layer"]
        DB["Database Manager"]
        MapSerial["Map Serialization"]
        PlayerData["Player Data Handler"]
        
        DB --> MapSerial
        DB --> PlayerData
    end

    %% Cross-layer connections
    Client --> GameLogic
    GameLogic --> World
    World --> Storage
    Storage --> GameLogic

    %% Additional Core Components
    Config["Configuration Manager"]
    TaskScheduler["Task Scheduler"]
    Security["Security (RSA/XTEA)"]

    Config --> GameEngine
    TaskScheduler --> GameEngine
    Security --> Protocol

    %% Click events for component mapping
    click Protocol "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/protocol.h"
    click Network "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/networkmessage.h"
    click Connection "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/connection.h"
    click GameEngine "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/game.cpp"
    click Combat "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/combat.cpp"
    click ScriptEngine "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/luascript.cpp"
    click EventHandler "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/events.cpp"
    click MapSystem "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/map.cpp"
    click Creatures "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/creature.cpp"
    click Items "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/items.cpp"
    click Spawn "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/spawn.cpp"
    click DB "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/database.cpp"
    click MapSerial "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/iomapserialize.cpp"
    click PlayerData "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/iologindata.cpp"
    click Config "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/configmanager.cpp"
    click TaskScheduler "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/scheduler.cpp"
    click Security "https://github.com/joseluis2g/opinionatedforgottenserver/blob/master/src/rsa.h"

    %% Style applications
    class Protocol,Network,Connection network
    class GameEngine,Combat,EventHandler gamelogic
    class ScriptEngine script
    class MapSystem,Creatures,Items,Spawn gamelogic
    class DB,MapSerial,PlayerData storage
    class Security security
```
