# kbengine/kbengine_unity3d_plugins architecture

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

- Interactive diagram: https://gitdiagram.com/kbengine/kbengine_unity3d_plugins
- Repository: https://github.com/kbengine/kbengine_unity3d_plugins

## Overview

##### Project type and purpose
- This is a Unity3D client‐side plugin library (C#) for KBEngine, a distributed MMO server framework.
- It provides an API, networking layer, event system, and entity model so Unity games can connect to KBEngine servers (loginapp/baseapp/cellapp), send/receive messages, synchronize entity state, and handle callbacks.

##### File structure
- All source files are at the root of the package and form a single C# assembly (no separate “Frontend/Backend” folders).
- Core namespaces and classes:
- KBEngine.cs & KBEMain.cs – entry point & lifecycle hooks
- NetworkInterface.cs, PacketSender/PacketReceiver.cs, MessageReader.cs, Bundle.cs, MemoryStream.cs – low‐level networking & serialization
- Entity.cs, EntityDef.cs, EntityCall.cs, Method.cs, Property.cs, Event.cs – entity‐model & RPC abstractions
- ScriptModule.cs – script binding & module loader
- DataTypes.cs, Message.cs, KBEngineArgs.cs – message definitions & argument wrappers
- No build scripts in repo; the assembly is imported by Unity, which uses Mono to compile and link it.

##### README for additional insights
- The README shows how Unity code subclasses KBEMain to launch the plugin, how client‐side entities subclass KBEngine.Entity, how to register and fire events in/out of the plugin, and which server messages and entity events are exposed.
- It outlines an event‐driven architecture: “fireIn” for Unity→KBEngine, “fireOut” for KBEngine→Unity.

##### Main components and relationships
a. Components
- Unity Game Code (MonoBehaviour scripts, UI classes)
- KBEngine Unity3D Plugin (C# assembly)
- Networking Layer (NetworkInterface, PacketSender, PacketReceiver, MessageReader, MemoryStream, Bundle)
- Entity & RPC Layer (Entity, EntityCall, EntityDef, Method, Property)
- Event System (Event.registerOut, Event.fireIn)
- External KBEngine Servers (Loginapp, Baseapp, Cellapp)
- Optional DataStore/Third‐Party Account System
b. Relationships & Data Flows
1. Unity Game Code calls Plugin APIs (KBEMain.Start(), Entity.baseCall()/cellCall(), Event.fireIn).
2. Plugin serializes calls into Bundles via Message, KBEngineArgs, DataTypes.
3. PacketSender sends serialized payload over socket via NetworkInterface.
4. KBEngine Server processes RPC, updates entity state, and sends messages back.
5. PacketReceiver receives raw bytes; MessageReader parses them into high‐level events.
6. Event.fireOut invokes registered Unity callbacks (onEnterWorld, onConnectionState, etc.).
7. Unity UI/Game Code handles events, updates game world, triggers new RPCs.
c. Architectural patterns & design principles
- Event‐Driven / Observer pattern for cross‐layer notifications
- Adapter/Facade pattern wrapping raw sockets and byte streams into high‐level C# APIs
- Entity‐Component pattern: client entity classes mirror server‐side definitions
- Separation of concerns: Networking layer isolated from entity logic and Unity callbacks
d. Key technologies/frameworks/libraries
- Unity3D engine and Mono scripting runtime
- KBEngine distributed server framework (Loginapp, Baseapp, Cellapp)
- C# .NET standard library for streams, collections, events

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Unity Layer
    subgraph "Unity Game Code"
        UI["MonoBehaviour Scripts & UI"]:::unity
        UI -->|"calls KBEMain.Start()"| KBEMain
    end

    %% Plugin Layer
    subgraph "KBEngine Plugin"
        subgraph "Entry & Lifecycle"
            KBEngine["KBEngine.cs"]:::entry
            KBEMain["KBEMain.cs"]:::entry
        end

        subgraph "Script Binding"
            SM["ScriptModule.cs"]:::script
        end

        subgraph "Event System"
            EVT["Event.cs"]:::event
        end

        subgraph "Entity & RPC Layer"
            E["Entity.cs"]:::rpc
            ED["EntityDef.cs"]:::rpc
            EC["EntityCall.cs"]:::rpc
            MTD["Method.cs"]:::rpc
            PROP["Property.cs"]:::rpc
        end

        subgraph "Networking Layer"
            NI["NetworkInterface.cs"]:::network
            PS["PacketSender.cs"]:::network
            PR["PacketReceiver.cs"]:::network
            MR["MessageReader.cs"]:::network
            BDL["Bundle.cs"]:::network
            MS["MemoryStream.cs"]:::network
        end

        subgraph "Message Definitions"
            DT["DataTypes.cs"]:::msg
            MSG["Message.cs"]:::msg
            ARG["KBEngineArgs.cs"]:::msg
        end
    end

    %% External Layer
    subgraph "KBEngine Servers"
        LA["Loginapp"]:::external
        BA["Baseapp"]:::external
        CA["Cellapp"]:::external
    end
    DB["Account DB / DataStore"]:::external

    %% Internal Flows
    KBEMain -->|"initializes"| SM
    UI -->|"subclasses Entity"| E
    UI -->|"registers callbacks"| EVT
    UI -->|"fireIn()"| EVT

    E -->|"EntityCall.cellCall()/baseCall()"| EC
    EC -->|"uses definitions"| ED
    EC -->|"uses RPC metadata"| MTD
    EC -->|"uses RPC metadata"| PROP
    EC -->|"builds bundle"| BDL

    BDL -->|"writes stream"| MS
    BDL -->|"serializes types"| DT
    BDL -->|"constructs message"| MSG
    BDL -->|"wraps arguments"| ARG
    BDL --> PS
    PS --> NI
    NI -->|TCP/UDP| LA
    NI -->|TCP/UDP| BA
    NI -->|TCP/UDP| CA

    LA --> NI
    BA --> NI
    CA --> NI
    NI --> PR
    PR --> MR
    MR -->|"parses events"| EVT
    EVT -->|"invokes callbacks"| UI
    UI -->|"updates game world"| UI

    %% Click Events
    click KBEngine "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/KBEngine.cs"
    click KBEMain "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/KBEMain.cs"
    click NI "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/NetworkInterface.cs"
    click PS "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/PacketSender.cs"
    click PR "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/PacketReceiver.cs"
    click MR "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/MessageReader.cs"
    click BDL "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/Bundle.cs"
    click MS "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/MemoryStream.cs"
    click E "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/Entity.cs"
    click ED "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/EntityDef.cs"
    click EC "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/EntityCall.cs"
    click MTD "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/Method.cs"
    click PROP "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/Property.cs"
    click EVT "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/Event.cs"
    click SM "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/ScriptModule.cs"
    click DT "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/DataTypes.cs"
    click MSG "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/Message.cs"
    click ARG "https://github.com/kbengine/kbengine_unity3d_plugins/blob/master/KBEngineArgs.cs"

    %% Styles
    classDef unity fill:#D0E6FF,stroke:#333,stroke-width:1px
    classDef network fill:#D6FFD6,stroke:#333,stroke-width:1px
    classDef rpc fill:#BFFFBF,stroke:#333,stroke-width:1px
    classDef event fill:#FFFBCC,stroke:#333,stroke-width:1px
    classDef script fill:#D6F5FF,stroke:#333,stroke-width:1px
    classDef msg fill:#F0E6FF,stroke:#333,stroke-width:1px
    classDef entry fill:#E0FFE0,stroke:#333,stroke-width:1px
    classDef external fill:#FFE0B2,stroke:#333,stroke-width:1px
```
