# ranviermud/core architecture

> Architecture diagram of the GitHub repository ranviermud/core, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ranviermud/core
- Repository: https://github.com/ranviermud/core

## Overview

##### Main Components Identification

The system can be broken down into several core subsystems:

a. Entity Management Layer
- Account/Player Management (Account.js, Player.js, PlayerManager.js)
- NPC/Mob Management (Npc.js, MobFactory.js, MobManager.js)
- Item Management (Item.js, ItemFactory.js, ItemManager.js)

b. World Management Layer
- Area Management (Area.js, AreaManager.js, AreaFactory.js)
- Room Management (Room.js, RoomManager.js, RoomFactory.js)
- Party System (Party.js, PartyManager.js)

c. Game Mechanics Layer
- Combat/Skills (Skill.js, SkillManager.js, Damage.js, Heal.js)
- Effects System (Effect.js, EffectFactory.js, EffectList.js)
- Quest System (Quest.js, QuestFactory.js, QuestTracker.js)

d. Communication Layer
- Channel System (Channel.js, ChannelManager.js)
- Broadcast System (Broadcast.js)
- Various Audience Types (WorldAudience.js, RoomAudience.js, etc.)

##### Inner Circle: Core Systems
- Event Management (EventManager.js)
- Command Processing (CommandManager.js, CommandQueue.js)
- Data Management (Data.js, DataSourceRegistry.js)

##### Middle Circle: Game Logic
- Entity Management
- World Management
- Game Mechanics

##### Outer Circle: Interface Layer
- Communication Systems
- Player Interface
- Transport Layer (TransportStream.js)

##### Component Relationships

Key relationships:
- Manager-to-Entity relationships (e.g., PlayerManager → Player)
- Factory-to-Entity relationships (e.g., ItemFactory → Item)
- Event flow through the EventManager
- Command processing pipeline
- Data flow through the broadcast system

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Legend
        L1[Core Systems]:::core
        L2[Entity Management]:::entity
        L3[World Management]:::world
        L4[Game Mechanics]:::mechanics
        L5[Communication]:::communication
        L6((Factory)):::factory
        L7{Event Flow}:::event
    end

    subgraph "Core Engine"
        GS[GameServer]:::core
        EF((EntityFactory)):::factory
        EL((EntityLoader)):::factory
    end

    subgraph "Core Systems"
        EM{EventManager}:::event
        CM[CommandManager]:::core
        CQ[CommandQueue]:::core
        DM[DataSourceRegistry]:::core
        BM[BundleManager]:::core
    end

    subgraph "Entity Management"
        direction TB
        AM[AccountManager]:::entity
        PM[PlayerManager]:::entity
        MM[MobManager]:::entity
        IM[ItemManager]:::entity
        
        AF((AccountFactory)):::factory
        PF((PlayerFactory)):::factory
        MF((MobFactory)):::factory
        IF((ItemFactory)):::factory
        
        AC[Account]:::entity
        PL[Player]:::entity
        NPC[NPC]:::entity
        IT[Item]:::entity
    end

    subgraph "World Management"
        direction TB
        ARM[AreaManager]:::world
        RM[RoomManager]:::world
        PTM[PartyManager]:::world
        
        ARF((AreaFactory)):::factory
        RF((RoomFactory)):::factory
        
        AR[Area]:::world
        RO[Room]:::world
        PT[Party]:::world
    end

    subgraph "Game Mechanics"
        direction TB
        SM[SkillManager]:::mechanics
        QM[QuestManager]:::mechanics
        
        SK[Skill]:::mechanics
        DM[Damage]:::mechanics
        HL[Heal]:::mechanics
        EF[Effect]:::mechanics
        QT[QuestTracker]:::mechanics
    end

    subgraph "Communication"
        direction TB
        CHM[ChannelManager]:::communication
        BC[Broadcast]:::communication
        
        WA[WorldAudience]:::communication
        RA[RoomAudience]:::communication
        AA[AreaAudience]:::communication
        CA[ChannelAudience]:::communication
        PA[PartyAudience]:::communication
        PRA[PrivateAudience]:::communication
    end

    GS --> EF
    GS --> EL
    GS --> EM
    GS --> CM
    
    EM --> BC
    
    AM --> AC
    PM --> PL
    MM --> NPC
    IM --> IT
    
    ARM --> AR
    RM --> RO
    PTM --> PT
    
    CHM --> BC
    BC --> WA & RA & AA & CA & PA & PRA

    classDef core fill:#3498db
    classDef entity fill:#2ecc71
    classDef world fill:#f1c40f
    classDef mechanics fill:#e74c3c
    classDef communication fill:#9b59b6
    classDef factory fill:#95a5a6
    classDef event fill:#e67e22

    click GS "https://github.com/ranviermud/core/blob/master/src/GameServer.js"
    click EF "https://github.com/ranviermud/core/blob/master/src/EntityFactory.js"
    click EL "https://github.com/ranviermud/core/blob/master/src/EntityLoader.js"
    click AM "https://github.com/ranviermud/core/blob/master/src/AccountManager.js"
    click PM "https://github.com/ranviermud/core/blob/master/src/PlayerManager.js"
    click MM "https://github.com/ranviermud/core/blob/master/src/MobManager.js"
    click IM "https://github.com/ranviermud/core/blob/master/src/ItemManager.js"
    click AC "https://github.com/ranviermud/core/blob/master/src/Account.js"
    click PL "https://github.com/ranviermud/core/blob/master/src/Player.js"
    click NPC "https://github.com/ranviermud/core/blob/master/src/Npc.js"
    click IT "https://github.com/ranviermud/core/blob/master/src/Item.js"
    click ARM "https://github.com/ranviermud/core/blob/master/src/AreaManager.js"
    click RM "https://github.com/ranviermud/core/blob/master/src/RoomManager.js"
    click PTM "https://github.com/ranviermud/core/blob/master/src/PartyManager.js"
    click AR "https://github.com/ranviermud/core/blob/master/src/Area.js"
    click RO "https://github.com/ranviermud/core/blob/master/src/Room.js"
    click PT "https://github.com/ranviermud/core/blob/master/src/Party.js"
    click SM "https://github.com/ranviermud/core/blob/master/src/SkillManager.js"
    click SK "https://github.com/ranviermud/core/blob/master/src/Skill.js"
    click DM "https://github.com/ranviermud/core/blob/master/src/Damage.js"
    click HL "https://github.com/ranviermud/core/blob/master/src/Heal.js"
    click QT "https://github.com/ranviermud/core/blob/master/src/QuestTracker.js"
    click CHM "https://github.com/ranviermud/core/blob/master/src/ChannelManager.js"
    click BC "https://github.com/ranviermud/core/blob/master/src/Broadcast.js"
    click WA "https://github.com/ranviermud/core/blob/master/src/WorldAudience.js"
    click RA "https://github.com/ranviermud/core/blob/master/src/RoomAudience.js"
    click AA "https://github.com/ranviermud/core/blob/master/src/AreaAudience.js"
    click CA "https://github.com/ranviermud/core/blob/master/src/ChannelAudience.js"
    click PA "https://github.com/ranviermud/core/blob/master/src/PartyAudience.js"
    click PRA "https://github.com/ranviermud/core/blob/master/src/PrivateAudience.js"
    click EM "https://github.com/ranviermud/core/blob/master/src/EventManager.js"
    click CM "https://github.com/ranviermud/core/blob/master/src/CommandManager.js"
    click CQ "https://github.com/ranviermud/core/blob/master/src/CommandQueue.js"
    click DM "https://github.com/ranviermud/core/blob/master/src/DataSourceRegistry.js"
    click BM "https://github.com/ranviermud/core/blob/master/src/BundleManager.js"
```
