# jaron-wilson/minecraftplugins architecture

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

- Interactive diagram: https://gitdiagram.com/jaron-wilson/minecraftplugins
- Repository: https://github.com/jaron-wilson/minecraftplugins

## Overview

##### Project type and purpose
- This “minecraftPlugins” repo is a multi-module Maven workspace where each top-level folder (e.g. CustomBossesAndWeapons, GamericaPlugin, Duel, etc.) is an independent Bukkit/Spigot plugin written in Java.
- Each plugin’s job is to hook into the Minecraft server API (Bukkit), register commands and event listeners, manage game state or custom content (bosses, NPCs, minigames), and persist configuration or runtime data in YAML files.

##### File structure
- You have N Maven modules (one per plugin). Each module has:
- pom.xml (build/dependencies)
- src/main/java/me/...   – Java packages for:
– Main plugin class (implements JavaPlugin)
– commands/ (CommandExecutors & TabCompleters)
– listeners/ (EventListeners for player join, block break, damage, etc.)
– managers/ or util/ (singleton-style classes handling config, item registry, NPC registry, etc.)
– subpackages (e.g. custom/itemEvents, allnpcs, mobManager, guis, minigames) for feature domains
- src/main/resources/plugin.yml (plugin metadata)
optional config.yml and data.yml for runtime persistence
- Pattern: Event-driven architecture using the Bukkit event bus + Command pattern. Managers and utility classes encapsulate business logic.

##### Extract insights from README
- The README confirms these are standalone plugins, each with a focused domain:
- CustomBossesAndWeapons: custom items/events, NPCs, bosses, recipes
- GamericaPlugin: minigames framework, AFK, quest NPCs
- Duel: 1v1 arenas, stats, kits
…etc.

a. Main components
– Minecraft Server (Bukkit API)
– Plugin Loader & Lifecycle (JavaPlugin class in each module)
– Event Bus & Command Dispatcher (provided by Bukkit)
– Feature Domains (packages / modules):
- Command Modules (commands/)
- Event Listeners (listeners/)
- Managers (ConfigManager, NPCManager, ItemManager, ArenaManager, etc.)
- Domain Services (mobManager, custom/itemEvents, guis, minigames, npcthings)
– Persistence Layer (YAML files: config.yml, data.yml)
– External Services (Vault economy/chat, Citizens NPC API, Metrics)
b. Relationships and interactions
– Server → onEnable(): loads plugin, instantiates MainClass
– MainClass → registers Commands & Listeners with Server
– Player issues /command → CommandDispatcher → CommandExecutor → calls Manager or Domain Service → updates game world or actor
– Server fires Event (PlayerJoin, BlockBreak, EntityDamage) → EventBus → appropriate Listener → invokes business logic in Manager/Service
– Managers read/write config/data files asynchronously or on shutdown
– Domain Services may call external APIs (Vault, Citizens) or schedule Tasks (timers)
c. Architectural patterns & design principles
– Event-driven design (publish/subscribe via Bukkit event bus)
– Command pattern (each command handler implements CommandExecutor)
– Manager/Service singletons encapsulating state and shared behavior
– Layered separation: API (commands & listeners) → Business Logic (managers/services) → Persistence
– Dependency injection is manual: MainClass passes references to managers when registering listeners/commands
d. Key technologies, frameworks, libraries
– Java & Bukkit/Spigot API
– Maven for build/dependency management
– SnakeYAML (bundled in Bukkit) for YAML config/data
– Optional plugins: Vault, Citizens, Metrics (bStats)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Global Bukkit Server
    Server["Bukkit Server"]:::core

    %% CustomBossesAndWeapons Plugin Module
    subgraph "CustomBossesAndWeapons"
        direction TB
        CBW_Main["MainClass"]:::core
        CBW_Commands["Command Modules"]:::api
        CBW_Listeners["Event Listeners"]:::api
        CBW_NPC["NPC Management"]:::logic
        CBW_Items["Custom Item Event Handlers"]:::logic
        CBW_Mobs["Mob Manager & Bosses"]:::logic
        CBW_Guis["GUI Engine"]:::logic
        CBW_Managers["Managers"]:::logic
        CBW_PluginYML["plugin.yml"]:::persistence
        CBW_ConfigYML["config.yml"]:::persistence
        CBW_DataYML["data.yml"]:::persistence

        Server -->|loads| CBW_Main
        CBW_Main -->|registers| CBW_Commands
        CBW_Main -->|registers| CBW_Listeners
        CBW_Commands -->|invoke| CBW_Managers
        CBW_Listeners -->|invoke| CBW_Managers
        CBW_Managers -->|manages| CBW_NPC
        CBW_Managers -->|manages| CBW_Items
        CBW_Managers -->|manages| CBW_Mobs
        CBW_Managers -->|manages| CBW_Guis
        CBW_Managers -->|read/write| CBW_PluginYML
        CBW_Managers -->|read/write| CBW_ConfigYML
        CBW_Managers -->|read/write| CBW_DataYML
    end

    %% Duel Plugin Module
    subgraph "Duel"
        direction TB
        Duel_Main["Duels"]:::core
        Duel_Commands["Command Dispatcher & TabCompleter"]:::api
        Duel_Events["Event Listeners"]:::api
        Arena_Manager["ArenaManager"]:::logic
        Arena_Model["Arena"]:::logic
        Kit_Manager["KitManager"]:::logic
        Duel_Utils["Utility Classes"]:::logic
        Duel_PluginYML["plugin.yml"]:::persistence
        Duel_ConfigYML["config.yml"]:::persistence
        Duel_StatsYML["Stats.yml"]:::persistence

        Server -->|loads| Duel_Main
        Duel_Main -->|registers| Duel_Commands
        Duel_Main -->|registers| Duel_Events
        Duel_Commands -->|invoke| Arena_Manager
        Duel_Events -->|invoke| Arena_Manager
        Arena_Manager -->|manages| Arena_Model
        Arena_Manager -->|calls| Kit_Manager
        Kit_Manager -->|uses| Duel_Utils
        Duel_Utils -->|read/write| Duel_PluginYML
        Duel_Utils -->|read/write| Duel_ConfigYML
        Duel_Utils -->|read/write| Duel_StatsYML
    end

    %% GamericaPlugin Module
    subgraph "GamericaPlugin"
        direction TB
        Gam_Main["GamericaPlugin"]:::core
        Gam_GlobalCommands["Global Commands"]:::api
        Gam_AFK["AFK Module"]:::api
        Gam_Minigame["Minigame Framework"]:::logic
        Gam_QuestNPC["Quest NPC & Bodies Engine"]:::logic
        Gam_Updater["Updater Service"]:::external
        Gam_PluginYML["plugin.yml"]:::persistence
        Gam_ConfigYML["config.yml"]:::persistence

        Server -->|loads| Gam_Main
        Gam_Main -->|registers| Gam_GlobalCommands
        Gam_Main -->|registers| Gam_AFK
        Gam_Main -->|registers| Gam_Minigame
        Gam_Main -->|registers| Gam_QuestNPC
        Gam_Main -->|starts| Gam_Updater
        Gam_AFK -->|invoke| Gam_Updater
        Gam_Minigame -->|invoke| Gam_Updater
        Gam_QuestNPC -->|invoke| Gam_Updater
        Gam_GlobalCommands -->|invoke| Gam_Updater
        Gam_Minigame -->|read/write| Gam_ConfigYML
        Gam_QuestNPC -->|read/write| Gam_ConfigYML
        Gam_Updater -->|read/write| Gam_PluginYML
    end

    %% Click Events for CustomBossesAndWeapons
    click CBW_Main "https://github.com/jaron-wilson/minecraftplugins/blob/main/CustomBossesAndWeapons/src/main/java/me/jaron/plugin/MainClass.java"
    click CBW_NPC "https://github.com/jaron-wilson/minecraftplugins/tree/main/CustomBossesAndWeapons/src/main/java/me/jaron/plugin/allnpcs"
    click CBW_Commands "https://github.com/jaron-wilson/minecraftplugins/tree/main/CustomBossesAndWeapons/src/main/java/me/jaron/plugin/commands"
    click CBW_Items "https://github.com/jaron-wilson/minecraftplugins/tree/main/CustomBossesAndWeapons/src/main/java/me/jaron/plugin/custom/itemEvents"
    click CBW_Mobs "https://github.com/jaron-wilson/minecraftplugins/tree/main/CustomBossesAndWeapons/src/main/java/me/jaron/plugin/custom/mobManager"
    click CBW_Guis "https://github.com/jaron-wilson/minecraftplugins/tree/main/CustomBossesAndWeapons/src/main/java/me/jaron/plugin/guis"
    click CBW_Managers "https://github.com/jaron-wilson/minecraftplugins/tree/main/CustomBossesAndWeapons/src/main/java/me/jaron/plugin/managers"
    click CBW_PluginYML "https://github.com/jaron-wilson/minecraftplugins/blob/main/CustomBossesAndWeapons/src/main/resources/plugin.yml"
    click CBW_ConfigYML "https://github.com/jaron-wilson/minecraftplugins/blob/main/CustomBossesAndWeapons/src/main/resources/config.yml"
    click CBW_DataYML "https://github.com/jaron-wilson/minecraftplugins/blob/main/CustomBossesAndWeapons/src/main/resources/data.yml"

    %% Click Events for Duel
    click Duel_Main "https://github.com/jaron-wilson/minecraftplugins/blob/main/Duel/src/main/java/me/dartanman/duels/Duels.java"
    click Arena_Manager "https://github.com/jaron-wilson/minecraftplugins/blob/main/Duel/src/main/java/me/dartanman/duels/arenas/ArenaManager.java"
    click Arena_Model "https://github.com/jaron-wilson/minecraftplugins/blob/main/Duel/src/main/java/me/dartanman/duels/arenas/Arena.java"
    click Duel_Commands "https://github.com/jaron-wilson/minecraftplugins/tree/main/Duel/src/main/java/me/dartanman/duels/commands"
    click Duel_Events "https://github.com/jaron-wilson/minecraftplugins/blob/main/Duel/src/main/java/me/dartanman/duels/events/ArenaEvents.java"
    click Kit_Manager "https://github.com/jaron-wilson/minecraftplugins/blob/main/Duel/src/main/java/me/dartanman/duels/kits/KitManager.java"
    click Duel_Utils "https://github.com/jaron-wilson/minecraftplugins/tree/main/Duel/src/main/java/me/dartanman/duels/utils"
    click Duel_PluginYML "https://github.com/jaron-wilson/minecraftplugins/blob/main/Duel/src/main/resources/plugin.yml"
    click Duel_ConfigYML "https://github.com/jaron-wilson/minecraftplugins/blob/main/Duel/src/main/resources/config.yml"
    click Duel_StatsYML "https://github.com/jaron-wilson/minecraftplugins/blob/main/Duel/src/main/resources/Stats.yml"

    %% Click Events for GamericaPlugin
    click Gam_Main "https://github.com/jaron-wilson/minecraftplugins/blob/main/GamericaPlugin/src/main/java/me/jaron/gamerica/plugin/GamericaPlugin.java"
    click Gam_AFK "https://github.com/jaron-wilson/minecraftplugins/tree/main/GamericaPlugin/src/main/java/me/jaron/gamerica/plugin/afk"
    click Gam_GlobalCommands "https://github.com/jaron-wilson/minecraftplugins/tree/main/GamericaPlugin/src/main/java/me/jaron/gamerica/plugin/commands"
    click Gam_Minigame "https://github.com/jaron-wilson/minecraftplugins/tree/main/GamericaPlugin/src/main/java/me/jaron/gamerica/plugin/minigame"
    click Gam_QuestNPC "https://github.com/jaron-wilson/minecraftplugins/tree/main/GamericaPlugin/src/main/java/me/jaron/gamerica/plugin/questnpcAndBodys"
    click Gam_Updater "https://github.com/jaron-wilson/minecraftplugins/blob/main/GamericaPlugin/src/main/java/me/jaron/gamerica/plugin/updater/Updater.java"
    click Gam_PluginYML "https://github.com/jaron-wilson/minecraftplugins/blob/main/GamericaPlugin/src/main/resources/plugin.yml"
    click Gam_ConfigYML "https://github.com/jaron-wilson/minecraftplugins/blob/main/GamericaPlugin/src/main/resources/config.yml"

    %% Styles
    classDef core fill:#D0E6FF,stroke:#0366D6,color:#0366D6
    classDef api fill:#E6F4EA,stroke:#22863A,color:#22863A
    classDef logic fill:#FFF5B1,stroke:#D29922,color:#D29922
    classDef persistence fill:#FFEFEF,stroke:#D73A49,color:#D73A49
    classDef external fill:#F0E5FF,stroke:#6F42C1,color:#6F42C1
```
