# dogvane/dogse architecture

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

- Interactive diagram: https://gitdiagram.com/dogvane/dogse
- Repository: https://github.com/dogvane/dogse

## Overview

##### Project Type and Purpose
- This is a .NET‐based, full‐stack game server framework (“DogSE”) plus a complete demo game (“TradeAge”).
- DogSE provides:
- A client SDK (DogSE.Client.Core)
- A high‐performance server engine (DogSE.Server.Net, DogSE.Server.Core, DogSE.Server.Common)
- Pluggable database adapters (MySQL, MongoDB, XMLFile)
- A code‐generation tool (DogSE.Tools.CodeGeneration) to emit protocol proxies
- Utility libraries (DogSE.Library) and unit tests
- TradeAge shows end‐to‐end usage: client controller, entity, logic layers, a Unity client, server logic, protocol definitions, and database persistence.

##### Key Directories and Patterns
- DogSE/
- DogSE.Client.Core: client‐side networking, packet model, task & timer engines
- DogSE.Server.Net: low‐level socket handling, session & buffer management
- DogSE.Server.Core: server state machine, logic module loader, task scheduler, timer manager
- DogSE.Server.Database.*: IDataService implementations for MySQL, MongoDB, XMLFile
- DogSE.Tools.CodeGeneration: codegen for client‐ and server‐side proxies (Unity, AS3, C#)
- DogSE.Library: common utilities (collections, logging, serialization, threading, math)
- TradeAge/
- Client: layered Controller / Core / Entity / Logic / Simulator / UnityClient
- Server: Entity definitions, Logic modules, Database, Protocol, Interface definitions
- Example/: tutorial projects showing each DogSE module in isolation.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Layer
    subgraph "Client Layer"
        style CL fill:#D0E8FF,stroke:#000,stroke-width:1px
        CL_UI["UnityClient\n(Game UI)"]:::client
        CL_Sim["Simulator\n(Test Harness)"]:::client
        SDK["DogSE.Client.Core\n(Client SDK)"]:::client
        TA_Ctrl["TradeAge.Client.Controller"]:::client
        TA_Entity["TradeAge.Client.Entity"]:::client
        TA_Logic["TradeAge.Client.Logic"]:::client
        TA_Core["TradeAge.Client.Core\n(Network & Packet)"]:::client
    end

    %% Code Generation Tool
    subgraph "Design-time Tools"
        style CG fill:#EED2FF,stroke:#000,stroke-width:1px
        CodeGen["DogSE.Tools.CodeGeneration"]:::tool
        Protocol["TradeAge.Server.Protocol\n(Defs & Stubs)"]:::tool
        Interface["TradeAge.Server.Interface\n(RPC Contracts)"]:::tool
    end

    %% Network Layer
    subgraph "Network Layer"
        style NL fill:#D0FFD0,stroke:#000,stroke-width:1px
        ClientNet["Client Net Stack\n(PacketReader/Writer,\nSession, Connect)"]:::server
        ServerNet["Server Net Stack\n(Listener, ReceiveQueue,\nMessagePump)"]:::server
    end

    %% Engine Core
    subgraph "Server Engine Core"
        style EC fill:#D0FFD0,stroke:#000,stroke-width:1px
        Core["DogSE.Server.Core\n(NetStateManager,\nTaskManager, TimerThread)"]:::server
        Common["DogSE.Server.Common\n(Utilities)"]:::util
        ModuleMgr["LogicModuleManager\n(ILogicModule Plugins)"]:::server
        LoginMod["LoginModule"]:::server
        GameMod["GameModule"]:::server
        SceneMod["SceneModule"]:::server
    end

    %% Persistence Layer
    subgraph "Persistence Layer"
        style PL fill:#FFE0B2,stroke:#000,stroke-width:1px
        IData["IDataService\n& EntityProfile"]:::server
        MySQL["MySQLService\n(Adapter)"]:::persistence
        MongoDB["MongoDBService\n(Adapter)"]:::persistence
        XmlFile["XmlFileService\n(Adapter)"]:::persistence
        DB_MySQL["MySQL\n(Database)"]:::persistence
        DB_Mongo["MongoDB\n(Database)"]:::persistence
        DB_XML["XML File\n(Storage)"]:::persistence
    end

    %% Utilities & Examples
    subgraph "Utilities & Examples"
        style UX fill:#E0E0E0,stroke:#000,stroke-width:1px
        Utils["DogSE.Library\n(Common Utilities)"]:::util
        IvyOrm["IvyOrm\n(ORM)"]:::util
        MongoDrv["MongoDB.Driver"]:::util
        Examples["Example Projects"]:::util
    end

    %% TradeAge Server
    subgraph "TradeAge Server"
        style TS fill:#D0FFD0,stroke:#000,stroke-width:1px
        TA_Entity_S["TradeAge.Server.Entity"]:::server
        TA_Game["TradeAge.Server.Game\n(Game Host)"]:::server
        TA_Logic_S["TradeAge.Server.Logic"]:::server
        TA_DB_Custom["TradeAge.Server.Database\n(GameDB config)"]:::persistence
        TA_DB_Xml["TradeAge.Server.Database.XmlFile"]:::persistence
    end

    %% Runtime Flow
    CL_UI -->|request| SDK
    CL_Sim -->|request| SDK
    SDK -->|serialize| TA_Core
    TA_Core -->|transport| ClientNet
    ClientNet -->|TCP/UDP| ServerNet
    ServerNet -->|enqueue| Core
    Core -->|dispatch| ModuleMgr
    ModuleMgr -->|load| LoginMod & GameMod & SceneMod
    ModuleMgr -->|invoke| LoginMod
    ModuleMgr -->|invoke| GameMod
    ModuleMgr -->|invoke| SceneMod
    LoginMod -->|calls| IData
    GameMod -->|calls| IData
    SceneMod -->|calls| IData
    IData -->|implements| MySQL & MongoDB & XmlFile
    MySQL -->|connect| DB_MySQL
    MongoDB -->|connect| DB_Mongo
    XmlFile -->|store| DB_XML
    Core -->|response| ServerNet
    ServerNet -->|send| TA_Core
    TA_Core -->|deserialize| SDK
    SDK -->|dispatch| CL_UI & TA_Logic

    %% Design-time Flow
    CodeGen -->|generates| TA_Ctrl & TA_Logic & Protocol & Interface

    %% TradeAge Server Integration
    TA_Game -->|uses| TA_Entity_S & TA_Logic_S & TA_DB_Custom & TA_DB_Xml

    %% Click Events
    click SDK "https://github.com/dogvane/dogse/blob/master/DogSE/DogSE.Client.Core"
    click ServerNet "https://github.com/dogvane/dogse/blob/master/DogSE/DogSE.Server.Net"
    click Core "https://github.com/dogvane/dogse/blob/master/DogSE/DogSE.Server.Core"
    click Common "https://github.com/dogvane/dogse/blob/master/DogSE/DogSE.Server.Common"
    click Utils "https://github.com/dogvane/dogse/blob/master/DogSE/DogSE.Library"
    click CodeGen "https://github.com/dogvane/dogse/blob/master/DogSE/DogSE.Tools.CodeGeneration"
    click IData "https://github.com/dogvane/dogse/blob/master/DogSE/DogSE.Server.Database/IDataService.cs"
    click IData "https://github.com/dogvane/dogse/blob/master/DogSE/DogSE.Server.Database/EntityProfile.cs"
    click MySQL "https://github.com/dogvane/dogse/tree/master/DogSE/DogSE.Server.Database/MySql"
    click MongoDB "https://github.com/dogvane/dogse/blob/master/DogSE/DogSE.Server.Database.MongoDB"
    click Examples "https://github.com/dogvane/dogse/tree/master/Example/"
    click TA_Ctrl "https://github.com/dogvane/dogse/blob/master/TradeAge/Client/TradeAge.Client.Controller"
    click TA_Core "https://github.com/dogvane/dogse/blob/master/TradeAge/Client/TradeAge.Client.Core"
    click TA_Entity "https://github.com/dogvane/dogse/blob/master/TradeAge/Client/TradeAge.Client.Entity"
    click TA_Logic "https://github.com/dogvane/dogse/blob/master/TradeAge/Client/TradeAge.Client.Logic"
    click CL_Sim "https://github.com/dogvane/dogse/blob/master/TradeAge/Client/TradeAge.Client.Simulator"
    click CL_UI "https://github.com/dogvane/dogse/tree/master/TradeAge/Client/UnityClient"
    click TA_Entity_S "https://github.com/dogvane/dogse/blob/master/TradeAge/Server/TradeAge.Server.Entity"
    click TA_Game "https://github.com/dogvane/dogse/blob/master/TradeAge/Server/TradeAge.Server.Game"
    click TA_Logic_S "https://github.com/dogvane/dogse/blob/master/TradeAge/Server/TradeAge.Server.Logic"
    click Protocol "https://github.com/dogvane/dogse/blob/master/TradeAge/Server/TradeAge.Server.Protocol"
    click Interface "https://github.com/dogvane/dogse/blob/master/TradeAge/TradeAge.Server.Interface"
    click TA_DB_Custom "https://github.com/dogvane/dogse/blob/master/TradeAge/TradeAge.Server.Database"
    click TA_DB_Xml "https://github.com/dogvane/dogse/blob/master/TradeAge/Server/TradeAge.Server.Database.XmlFile"

    %% Styles
    classDef client fill:#D0E8FF,stroke:#000;
    classDef server fill:#D0FFD0,stroke:#000;
    classDef persistence fill:#FFE0B2,stroke:#000;
    classDef util fill:#E0E0E0,stroke:#000;
    classDef tool fill:#EED2FF,stroke:#000;
```
