# inglettronald/dulkirmod architecture

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

- Interactive diagram: https://gitdiagram.com/inglettronald/dulkirmod
- Repository: https://github.com/inglettronald/dulkirmod

## Overview

##### Project Type and Purpose
- Type: A client-side Minecraft mod (Forge/Fabric style) written in Kotlin/Java.
- Purpose: Inject new behaviors, commands, HUD overlays, event listeners, and rendering changes into the Minecraft client using Mixins.

##### High-Level Components
a. External Host
- Minecraft Game Engine
- Mod Loader (Fabric/Forge)
b. Core Mod
- Entry Point (DulkirMod.kt)
- Configuration Manager
- Event Dispatcher
- Command Processor
c. Mixin Injection Layer
- Mixins under src/main/java/dulkirmod/mixins
- JSON config (mixins.dulkirmod.json)
d. Feature Modules
- src/main/kotlin/dulkirmod/features
- src/main/kotlin/dulkirmod/features/chat
- src/main/kotlin/dulkirmod/features/dungeons
- src/main/kotlin/dulkirmod/features/rift
e. Overlays / Renderers
- src/main/kotlin/dulkirmod/overlays
f. Utilities
- src/main/kotlin/dulkirmod/utils
- src/main/kotlin/dulkirmod/config
g. Resources
- src/main/resources (assets, sounds, mod info)
h. Build & Deployment
- build.gradle.kts, gradle wrappers, log4j2.xml

##### Relationships & Data Flows
- At startup, the Mod Loader reads build metadata, loads the mixin JSON, and invokes DulkirMod.kt.
- DulkirMod registers:
- Event listeners (Events.kt → features → utilities)
- Client commands (ClientCommandBase → individual commands)
- Config system reads from disk (DulkirConfig.kt → ConfigData.kt)
- Minecraft engine calls into injected mixin methods (e.g., MixinEntityRenderer) to alter rendering or game logic.
- Mixins funnel modified game state into the Event Dispatcher.
- The Event Dispatcher broadcasts to subscribed feature modules.
- Feature modules compute HUD state or control logic, emitting overlay instructions.
- Overlay classes render additional HUD elements via Minecraft’s rendering pipeline.
- Utility classes support shared operations (text formatting, scoreboard queries, waypoint math).

##### Architectural Patterns & Design Principles
- Modular Feature Pattern: each feature lives in its own file/package under features/ and subscribes to events it cares about.
- Mixin-based Inversion of Control: instead of direct subclassing, use mixins to inject into existing game classes.
- Centralized Event Bus: decouples game lifecycle hooks from features and overlays.
- Command Framework: base class (ClientCommandBase) with concrete commands under command/.
- Config-Driven Behavior: settings loaded/serialized via config classes, exposed to users via /dulkir.

##### Checklist
- [ ] Build & Deployment annotation (Gradle files, log4j2.xml)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Host
    subgraph "External Host"
        MinecraftEngine["Minecraft Game Engine"]:::external
        ModLoader["Mod Loader (Fabric/Forge)"]:::external
    end

    %% Core Mod
    subgraph "Core Mod"
        DulkirMod["DulkirMod.kt\n(Entry Point)"]:::core
        ConfigManager["DulkirConfig.kt\n(Configuration Manager)"]:::config
        ConfigData["ConfigData.kt\n(Config Data Model)"]:::utils
        EventDispatcher["Events.kt\n(Event Dispatcher)"]:::core
        CommandProcessor["ClientCommandBase.kt\n(Command Processor)"]:::core
        ChatEventListener["ChatEvent.kt\n(Chat Event Listener)"]:::core
        HelpCommand["HelpCommand.kt"]:::core
        LeapNameCommand["LeapNameCommand.kt"]:::core
        SettingsCommand["SettingsCommand.kt"]:::core
    end

    %% Mixin Layer
    subgraph "Mixin Layer"
        MixinConfig["mixins.dulkirmod.json"]:::resources
        subgraph "Java Mixin Classes"
            AccessorRenderManager["AccessorRenderManager.java"]:::mixin
            MixinEntity["MixinEntity.java"]:::mixin
            MixinEntityLivingBase["MixinEntityLivingBase.java"]:::mixin
            MixinEntityRenderer["MixinEntityRenderer.java"]:::mixin
            MixinGuiContainer["MixinGuiContainer.java"]:::mixin
            MixinGuiScreen["MixinGuiScreen.java"]:::mixin
            MixinGuiUtils["MixinGuiUtils.java"]:::mixin
            MixinItem["MixinItem.java"]:::mixin
            MixinItemRenderer["MixinItemRenderer.java"]:::mixin
            MixinLayerArmorBase["MixinLayerArmorBase.java"]:::mixin
            MixinOldAnimations["MixinOldAnimations.java"]:::mixin
            MixinRenderManager["MixinRenderManager.java"]:::mixin
            MixinSoundManager["MixinSoundManager.java"]:::mixin
            MixinWorld["MixinWorld.java"]:::mixin
        end
    end

    %% Features
    subgraph "Feature Modules"
        FeaturesRoot["dulkirmod/features"]:::features
        ChatFeature["chat"]:::features
        DungeonsFeature["dungeons"]:::features
        RiftFeature["rift"]:::features
    end

    %% Overlays
    subgraph "Overlays / HUD Renderers"
        OverlaysRoot["dulkirmod/overlays"]:::overlays
    end

    %% Utilities
    Utils["dulkirmod/utils"]:::utils

    %% Resources & Build
    Resources["Resources\n(mcmod.info, Minecraftsounds.txt)"]:::resources
    Build["Build & Deployment\n(Gradle files, log4j2.xml)"]:::build

    %% Startup Flow
    ModLoader -->|loads mod| DulkirMod
    ModLoader -->|reads mixins json| MixinConfig
    DulkirMod -->|init| ConfigManager
    ConfigManager -->|loads data| ConfigData
    DulkirMod -->|register| EventDispatcher
    DulkirMod -->|register| CommandProcessor

    %% Runtime Flow
    MinecraftEngine -->|game events| AccessorRenderManager
    MinecraftEngine -->|game events| MixinEntity
    AccessorRenderManager -->|injects| EventDispatcher
    MixinEntity -->|injects| EventDispatcher
    MixinEntityLivingBase -->|injects| EventDispatcher
    MixinEntityRenderer -->|injects| EventDispatcher
    MixinGuiContainer -->|injects| EventDispatcher
    MixinGuiScreen -->|injects| EventDispatcher
    MixinGuiUtils -->|injects| EventDispatcher
    MixinItem -->|injects| EventDispatcher
    MixinItemRenderer -->|injects| EventDispatcher
    MixinLayerArmorBase -->|injects| EventDispatcher
    MixinOldAnimations -->|injects| EventDispatcher
    MixinRenderManager -->|injects| EventDispatcher
    MixinSoundManager -->|injects| EventDispatcher
    MixinWorld -->|injects| EventDispatcher

    EventDispatcher -->|broadcast| ChatFeature
    EventDispatcher -->|broadcast| DungeonsFeature
    EventDispatcher -->|broadcast| RiftFeature

    ChatFeature -->|emits overlay instructions| OverlaysRoot
    DungeonsFeature -->|emits overlay instructions| OverlaysRoot
    RiftFeature -->|emits overlay instructions| OverlaysRoot

    OverlaysRoot -->|renders HUD| MinecraftEngine

    %% Command Flow
    MinecraftEngine -->|chat input| ChatEventListener
    ChatEventListener -->|dispatch| CommandProcessor
    CommandProcessor -->|executes| HelpCommand
    CommandProcessor -->|executes| LeapNameCommand
    CommandProcessor -->|executes| SettingsCommand
    HelpCommand -->|update| EventDispatcher
    SettingsCommand -->|update config| ConfigManager

    %% Utilities Usage
    ConfigData --> Utils
    EventDispatcher --> Utils
    ChatFeature --> Utils
    DungeonsFeature --> Utils
    RiftFeature --> Utils
    OverlaysRoot --> Utils

    %% Resources & Build Relations
    MixinConfig --> Resources
    ConfigManager --> Resources
    DulkirMod --> Build

    %% Click Events
    click DulkirMod "https://github.com/inglettronald/dulkirmod/blob/master/src/main/kotlin/dulkirmod/DulkirMod.kt"
    click ConfigManager "https://github.com/inglettronald/dulkirmod/blob/master/src/main/kotlin/dulkirmod/config/DulkirConfig.kt"
    click ConfigData "https://github.com/inglettronald/dulkirmod/blob/master/src/main/kotlin/dulkirmod/utils/ConfigData.kt"
    click EventDispatcher "https://github.com/inglettronald/dulkirmod/blob/master/src/main/kotlin/dulkirmod/events/Events.kt"
    click ChatEventListener "https://github.com/inglettronald/dulkirmod/blob/master/src/main/kotlin/dulkirmod/events/ChatEvent.kt"
    click CommandProcessor "https://github.com/inglettronald/dulkirmod/blob/master/src/main/kotlin/dulkirmod/command/ClientCommandBase.kt"
    click HelpCommand "https://github.com/inglettronald/dulkirmod/blob/master/src/main/kotlin/dulkirmod/command/HelpCommand.kt"
    click LeapNameCommand "https://github.com/inglettronald/dulkirmod/blob/master/src/main/kotlin/dulkirmod/command/LeapNameCommand.kt"
    click SettingsCommand "https://github.com/inglettronald/dulkirmod/blob/master/src/main/kotlin/dulkirmod/command/SettingsCommand.kt"
    click AccessorRenderManager "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/AccessorRenderManager.java"
    click MixinEntity "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/MixinEntity.java"
    click MixinEntityLivingBase "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/MixinEntityLivingBase.java"
    click MixinEntityRenderer "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/MixinEntityRenderer.java"
    click MixinGuiContainer "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/MixinGuiContainer.java"
    click MixinGuiScreen "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/MixinGuiScreen.java"
    click MixinGuiUtils "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/MixinGuiUtils.java"
    click MixinItem "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/MixinItem.java"
    click MixinItemRenderer "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/MixinItemRenderer.java"
    click MixinLayerArmorBase "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/MixinLayerArmorBase.java"
    click MixinOldAnimations "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/MixinOldAnimations.java"
    click MixinRenderManager "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/MixinRenderManager.java"
    click MixinSoundManager "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/MixinSoundManager.java"
    click MixinWorld "https://github.com/inglettronald/dulkirmod/blob/master/src/main/java/dulkirmod/mixins/MixinWorld.java"
    click MixinConfig "https://github.com/inglettronald/dulkirmod/blob/master/src/main/resources/mixins.dulkirmod.json"
    click FeaturesRoot "https://github.com/inglettronald/dulkirmod/tree/master/src/main/kotlin/dulkirmod/features"
    click ChatFeature "https://github.com/inglettronald/dulkirmod/tree/master/src/main/kotlin/dulkirmod/features/chat"
    click DungeonsFeature "https://github.com/inglettronald/dulkirmod/tree/master/src/main/kotlin/dulkirmod/features/dungeons"
    click RiftFeature "https://github.com/inglettronald/dulkirmod/tree/master/src/main/kotlin/dulkirmod/features/rift"
    click OverlaysRoot "https://github.com/inglettronald/dulkirmod/tree/master/src/main/kotlin/dulkirmod/overlays"
    click Utils "https://github.com/inglettronald/dulkirmod/tree/master/src/main/kotlin/dulkirmod/utils"

    %% Styles
    classDef external fill:#87CEEB,stroke:#333,stroke-width:1px;
    classDef core fill:#ADD8E6,stroke:#333,stroke-width:1px;
    classDef config fill:#B0E0E6,stroke:#333,stroke-width:1px;
    classDef mixin fill:#FFA500,stroke:#333,stroke-width:1px;
    classDef features fill:#90EE90,stroke:#333,stroke-width:1px;
    classDef overlays fill:#DDA0DD,stroke:#333,stroke-width:1px;
    classDef utils fill:#D3D3D3,stroke:#333,stroke-width:1px;
    classDef resources fill:#F5DEB3,stroke:#333,stroke-width:1px;
    classDef build fill:#F5DEB3,stroke:#333,stroke-width:1px;
```
