# magemonkeystudio/fabled architecture

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

- Interactive diagram: https://gitdiagram.com/magemonkeystudio/fabled
- Repository: https://github.com/magemonkeystudio/fabled

## Overview

##### Project type and purpose
- This is a Java-based Minecraft server plugin (Paper/Spigot) and API library (“Fabled”) that extends SkillAPI to provide dynamic, data-driven RPG classes, skills, events, and mechanics on a Minecraft server.
- It is not a web or full-stack app, but a domain-specific plugin/tool designed to register commands, listen to in-game events, load and parse skill/class/trigger definitions (YAML), and apply game logic via a scheduler and event loop.

##### File structure
- Top‐level “src/main/java” contains two main packages:
- com.sucy.skill – the original SkillAPI fork core classes and interfaces
- studio.magemonkey.fabled – the Fabled plugin itself
- Under Fabled:
- api/… – public API interfaces and default implementations for classes, skills, events, player data, armor stands, particles, etc.
- data/… – configuration definitions, IO and SQL management
- dynamic/… – the engine for loading and running user-defined components: triggers, conditions, mechanics, targets, effects
- cmd/… – command definitions and dispatcher
- listener/… – Bukkit event listeners that funnel events into the Fabled engine
- hook/… – integrations with other plugins (Vault, PlaceholderAPI, etc.)
- gui/… – inventory-based GUIs for class/skill menus
- manager/… – singleton managers for attributes, combos, titles, resource loading
- shield/, cast/, task/, thread/, tree/, util/… – sub-domains handling shields, cast bars, scheduled tasks and threading, skill tree layouts, helper utilities
- Configuration and resource files in src/main/resources (YAML configs, plugin.yml, images, internal/jar modules).

##### README for additional insights
- Confirms this is a fork of SkillAPI with premium features and a “dynamic editor” external web service for authoring class/skill definitions.
- Provides Maven coordinates – this plugin is consumed as a library, so the API layer must be cleanly separated from implementation.

##### Elements
- Labels: e.g. JavaPlugin, ResourceManager, ComponentRegistry, SQLManager, Bukkit EventBus, TaskScheduler
- Plugin Enable → ConfigIO, SQLManager, ResourceManager
- Bukkit Event → FabledListener → DynamicEngine → MechanicExecutor
- DynamicEngine → TaskScheduler → Task Execution
- GUI click → GUIHandler → ResourceManager → PlayerData
- Green for core implementation managers
- Orange for dynamic engine components
- Purple for external hooks

##### Final advice
- Be very detailed: break the plugin down into its subsystems (entrypoint, config, data, engine, commands, GUI, persistence).
- How configuration files drive class/skill loading, how triggers and mechanics execute, and how data flows in and out via events and SQL/YAML.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Plugin Entry
    Fabled["Fabled (JavaPlugin)"]:::core
    click Fabled "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/Fabled.java"

    %% Configuration & Data Layer
    subgraph "Configuration & Data" 
        ConfigIO["ConfigIO (YAML Loader)"]:::core
        click ConfigIO "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/data/io/ConfigIO.java"
        IOManager["IOManager"]:::core
        click IOManager "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/data/io/IOManager.java"
        SQLManager["SQLManager"]:::core
        click SQLManager "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/data/sql/SQLManager.java"
        FabledPlayersSQL["FabledPlayersSQL (PlayerData Table)"]:::core
        click FabledPlayersSQL "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/data/sql/tables/FabledPlayersSQL.java"
    end

    %% Core Managers
    subgraph "Core Managers"
        RegistrationManager["RegistrationManager"]:::core
        click RegistrationManager "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/manager/RegistrationManager.java"
        ResourceManager["ResourceManager"]:::core
        click ResourceManager "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/manager/ResourceManager.java"
        AttributeManager["AttributeManager"]:::core
        click AttributeManager "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/manager/AttributeManager.java"
        ComboManager["ComboManager"]:::core
        click ComboManager "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/manager/ComboManager.java"
        TitleManager["TitleManager"]:::core
        click TitleManager "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/manager/TitleManager.java"
        ShieldManager["ShieldManager"]:::core
        click ShieldManager "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/shield/ShieldManager.java"
        ClassBoardManager["ClassBoardManager"]:::core
        click ClassBoardManager "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/manager/ClassBoardManager.java"
        CmdManager["CmdManager"]:::core
        click CmdManager "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/manager/CmdManager.java"
    end

    %% Dynamic Engine
    subgraph "Dynamic Engine" 
        ComponentRegistry["ComponentRegistry"]:::dynamic
        click ComponentRegistry "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/dynamic/ComponentRegistry.java"
        DynamicClass["DynamicClass"]:::dynamic
        click DynamicClass "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/dynamic/DynamicClass.java"
        DynamicSkill["DynamicSkill"]:::dynamic
        click DynamicSkill "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/dynamic/DynamicSkill.java"
        ConditionComponent["ConditionComponent"]:::dynamic
        click ConditionComponent "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/dynamic/condition/ConditionComponent.java"
        MechanicComponent["MechanicComponent"]:::dynamic
        click MechanicComponent "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/dynamic/mechanic/MechanicComponent.java"
        TriggerComponent["TriggerComponent"]:::dynamic
        click TriggerComponent "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/dynamic/trigger/TriggerComponent.java"
        TargetComponent["TargetComponent"]:::dynamic
        click TargetComponent "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/dynamic/target/TargetComponent.java"
    end

    %% Event System
    subgraph "Event System"
        BE["Bukkit Event"]:::external
        FabledListener["FabledListener"]:::core
        click FabledListener "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/listener/FabledListener.java"
        MechanicListener["MechanicListener"]:::core
        click MechanicListener "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/listener/MechanicListener.java"
        APIEvent["Fabled Custom Event"]:::api
    end

    %% Command Layer
    subgraph "Commands"
        PlayerInput["Player/Console"]:::external
        CmdCast["CmdCast"]:::core
        click CmdCast "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/cmd/CmdCast.java"
    end

    %% GUI Layer
    subgraph "GUI"
        GUIClick["Inventory Click"]:::external
        SkillHandler["SkillHandler"]:::core
        click SkillHandler "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/gui/handlers/SkillHandler.java"
    end

    %% Scheduler & Threads
    subgraph "Scheduler & Threading"
        MainThread["MainThread"]:::core
        click MainThread "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/thread/MainThread.java"
        TaskList["TaskList"]:::core
        click TaskList "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/thread/TaskList.java"
        CooldownTask["CooldownTask"]:::core
        click CooldownTask "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/task/CooldownTask.java"
        SaveTask["SaveTask"]:::core
        click SaveTask "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/task/SaveTask.java"
    end

    %% Hooks
    subgraph "External Hooks"
        VaultHook["VaultHook"]:::hook
        click VaultHook "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/hook/VaultHook.java"
        MythicMobsHook["MythicMobsHook"]:::hook
        click MythicMobsHook "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/hook/MythicMobsHook.java"
    end

    %% API Layer
    SkillPlugin["SkillPlugin Interface"]:::api
    click SkillPlugin "https://github.com/magemonkeystudio/fabled/blob/dev/src/main/java/studio/magemonkey/fabled/api/SkillPlugin.java"

    %% Relationships
    Fabled --> RegistrationManager
    RegistrationManager --> ConfigIO
    RegistrationManager --> SQLManager
    RegistrationManager --> ResourceManager
    ConfigIO --> IOManager
    SQLManager --> FabledPlayersSQL
    ResourceManager --> ComponentRegistry

    BE --> FabledListener
    FabledListener --> ComponentRegistry
    ComponentRegistry --> TriggerComponent
    TriggerComponent --> MechanicComponent
    MechanicComponent --> MechanicListener
    MechanicListener --> TaskList
    TaskList --> MainThread
    TaskList --> CooldownTask
    TaskList --> SaveTask
    MechanicListener --> PlayerInput
    MechanicListener --> APIEvent

    PlayerInput --> CmdManager
    CmdManager --> CmdCast
    CmdCast --> ComponentRegistry

    GUIClick --> SkillHandler
    SkillHandler --> ClassBoardManager
    ClassBoardManager --> PlayerInput

    ComponentRegistry --> DynamicClass
    ComponentRegistry --> DynamicSkill

    VaultHook --> ComponentRegistry
    MythicMobsHook --> ComponentRegistry

    APIEvent --> SkillPlugin

    %% Styles
    classDef core fill:#a8ddb5,stroke:#2b7a0b,color:#000;
    classDef dynamic fill:#feb24c,stroke:#b35a00,color:#000;
    classDef api fill:#9ecae1,stroke:#084594,color:#000;
    classDef hook fill:#cb181d,stroke:#7f0000,color:#fff;
    classDef external fill:#f0f0f0,stroke:#969696,color:#000;
```
