# ko4life-net/ko architecture

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

- Interactive diagram: https://gitdiagram.com/ko4life-net/ko
- Repository: https://github.com/ko4life-net/ko

## Overview

##### Project Type and Purpose
- This is a full‐stack MMORPG codebase (Knight Online) with four solution views: Game Client, Game Servers, Tools, and an “All” meta‐solution.
- The repository includes:
- A native C++/MFC game client (src/game) that links against the engine (src/engine) and common utilities (src/common).
- A suite of dedicated server processes (src/server/*. For example, LoginServer, AIServer, Ebenezer (game logic), ItemManager, Aujard (DB agent)).
- Dozens of Windows desktop tools (src/tool/… MFC editors, viewers, converters) for asset creation and debugging.
- Submodules for database schemas (ko-db), client assets (ko-assets), and utility SDKs (ko-vendor).
- CI/CD workflows for build, lint, test, and release on GitHub Actions.

##### File‐Structure Patterns and Architectural Layers
- Top‐Level Solutions (src/*.sln) group modules by domain: Game.sln (client+engine), Server.sln (all servers), Tool.sln (all editors), All.sln (everything).
- Shared libraries:
- src/common: parsing (INI), compression, encryption.
- src/engine/N3Base: 3D engine primitives, resource loaders, UI, audio, scene graph.
- Server subdirs each implement one service:
- LoginServer – authentication and version negotiation.
- Aujard – DB agent pooling connections to SQL Server.
- Ebenezer & AIServer – in‐memory game world logic and AI.
- ItemManager – specialized microservice for item data.
- Tools: each under src/tool; all MFC-based desktop apps reading/writing local files or connecting to servers.
- Infrastructure/config files: config.cmd for submodule init, format.ps1 for lint, GitHub workflows for CI/CD.

a. Frontend (Game Client)
- KnightOnLine.exe – MFC application
- Uses engine & common libraries
- Connects over TCP/UDP to LoginServer and then to game servers
b. Backend Services (Game Servers)
- LoginServer – TCP listener, negotiates credentials
- Aujard – DBagent service, talks to SQL Server
- Ebenezer/AIServer – game logic, zone management, NPC/AI threads
- ItemManager – item data CRUD
- SharedMem modules – shared memory segments for cross‐process data
c. Database Layer
- Microsoft SQL Server Express/Developer
- Tables managed by submodule ko-db
- Servers use ODBC/DBAgent to read/write player, item, zone, NPC tables
d. Tools & External Assets
- MFC editors (map editor, FX editor, texture viewer, etc.)
- Submodule ko-assets: models, textures, audio files
e. CI/CD & Build
- GitHub Actions: build-all, lint, test, deploy
- config.cmd fetches submodules; Visual Studio 2022 solutions compile all modules

- Client → LoginServer (authenticate, receive session token)
- Client → Ebenezer / AIServer cluster (game state, movement, combat packets)
- Servers ↔ SQL Server (persistent storage)
- Servers ↔ SharedMem (fast cross‐process reads)
- Tools ↔ Local File System / Asset Repositories (no live server comms, except optional preview sockets)
- CI/CD → GitHub → Build Runners → Binaries → (optional) Deployment scripts

##### Architectural Patterns & Principles
- N‐Tier Client‐Server: clear separation between client UI/engine, server logic, and database.
- Micro‐service style: each server process handles one domain (auth, game logic, AI, items).
- Shared native C++ libraries (engine/common) to avoid code duplication.
- MFC‐based desktop tools acting as “rich clients” for offline asset creation.
- Git submodules & config scripts to manage dependencies in a monorepo style.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Knight Online System"
        subgraph "Client Layer"
            KnightOnLine["KnightOnLine.exe"]:::frontend
            EngineLib["Engine Library\n(src/engine/N3Base)"]:::lib
            CommonLib["Common Utilities\n(src/common)"]:::lib
        end

        subgraph "Server Layer"
            LoginServer["LoginServer\n(TCP 15779)"]:::backend
            Aujard["Aujard (DB Agent)"]:::backend
            Ebenezer["Ebenezer (Game Logic)"]:::backend
            AIServer["AIServer (AI Service)"]:::backend
            ItemManager["ItemManager"]:::backend
            SharedMem["SharedMem Modules"]:::backend
        end

        subgraph "Database Layer"
            SQLServer["SQL Server"]:::data
            DBSchemas["ko-db Submodule"]:::data
        end

        subgraph "Tools & Assets"
            ToolsSuite["Tools Suite\n(src/tool/)"]:::tools
            AssetsRepo["Assets Repository\n(src/assets/)"]:::tools
        end

        subgraph "Infrastructure"
            VendorSDKs["Vendor SDKs\n(src/lib/Zip/)"]:::infra
            CICD["GitHub Actions\n(CI/CD)"]:::infra
            SubmoduleInit["Submodule Init & Scripts"]:::infra
        end
    end

    %% Data Flows
    KnightOnLine -->|"TCP/IOCPSocket"| LoginServer
    KnightOnLine -->|"TCP/UDP"| Ebenezer
    KnightOnLine -->|"TCP/UDP"| AIServer

    LoginServer -->|"ODBC/DBAgent"| SQLServer
    Aujard -->|"ODBC/DBAgent"| SQLServer
    Ebenezer -->|"SharedMem"| SharedMem
    AIServer -->|"SharedMem"| SharedMem
    ItemManager -->|"ODBC/DBAgent"| SQLServer

    ToolsSuite -->|"FS Access"| AssetsRepo

    CICD -->|"exec config.cmd"| SubmoduleInit
    SubmoduleInit -->|"fetch submodules"| VendorSDKs
    SubmoduleInit -->|"fetch submodules"| DBSchemas
    CICD -->|"build Solutions"| KnightOnLine
    CICD -->|"build Solutions"| LoginServer

    %% Dependencies
    KnightOnLine --> CommonLib
    KnightOnLine --> EngineLib
    LoginServer --> CommonLib
    Aujard --> CommonLib
    Ebenezer --> CommonLib
    AIServer --> CommonLib
    ItemManager --> CommonLib
    LoginServer --> EngineLib

    %% Click Events
    click KnightOnLine "https://github.com/ko4life-net/ko/tree/master/src/game/"
    click EngineLib "https://github.com/ko4life-net/ko/tree/master/src/engine/"
    click CommonLib "https://github.com/ko4life-net/ko/tree/master/src/common/"
    click LoginServer "https://github.com/ko4life-net/ko/tree/master/src/server/LoginServer/"
    click Aujard "https://github.com/ko4life-net/ko/tree/master/src/server/Aujard/"
    click Ebenezer "https://github.com/ko4life-net/ko/tree/master/src/server/Ebenezer/"
    click AIServer "https://github.com/ko4life-net/ko/tree/master/src/server/AIServer/"
    click ItemManager "https://github.com/ko4life-net/ko/tree/master/src/server/ItemManager/"
    click SharedMem "https://github.com/ko4life-net/ko/blob/master/src/server/Aujard/SharedMem.cpp"
    click ToolsSuite "https://github.com/ko4life-net/ko/tree/master/src/tool/"
    click AssetsRepo "https://github.com/ko4life-net/ko/tree/master/src/assets/"
    click DBSchemas "https://github.com/ko4life-net/ko/tree/master/src/db/"
    click VendorSDKs "https://github.com/ko4life-net/ko/tree/master/src/lib/Zip/"
    click CICD "https://github.com/ko4life-net/ko/blob/master/.github/workflows/build-all.yml"
    click SubmoduleInit "https://github.com/ko4life-net/ko/blob/master/config.cmd"

    %% Styles
    classDef frontend fill:#D0E6FF,stroke:#0B78E3,color:#000;
    classDef backend fill:#D4F5D4,stroke:#28A745,color:#000;
    classDef data fill:#FFE5B4,stroke:#E69500,color:#000;
    classDef tools fill:#F0F0F0,stroke:#666,color:#000;
    classDef infra fill:#EAD1DC,stroke:#A64D79,color:#000;
    classDef lib fill:#FFF2CC,stroke:#D6B656,color:#000;
```
