# frinshhd/anturniaquests architecture

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

- Interactive diagram: https://gitdiagram.com/frinshhd/anturniaquests
- Repository: https://github.com/frinshhd/anturniaquests

## Overview

- Plugin Core: The entry point is provided by the Main.java file, which likely extends JavaPlugin. Represent this as the “Core Plugin” or “Main Application.”
- Command Handling System: Include a module for commands (under the “commands” package). Break it down further into a hierarchy:
- BasicCommand and BasicSubCommand classes.
- The main QuestCommand and its subcommands (create, delete, dev, help, reload, reset, version, and the “edit” subbranches that handle adding/removing settings).
- Configuration Management: Represent this module (in the “config” package) which handles reading plugin configuration files (config.yml, categories.yml, quests.yml, storylines.yml, and messages.properties).
- Quest and Categories System: Represent the “quests” package (including QuestsManager and models) and “categories” package. These modules manage quest definitions, tracking, and categorization.
- Requirements and Rewards: The “requirements” package is extensive and broken into submodules (for block interactions, destroyed blocks, items, killed entities, mob breed, money, place block, placed blocks, reach location). Represent these as a “Requirements Manager” subsystem with individual requirement types.
- Event Listeners: Represent the listener components (such as JoinListener and PlayerKillEntityListener under “listener”, plus listeners in the “storylines” and “menusystem” packages). These modules handle in-game events.
- Menu and UI System: The “menusystem” package (including Menu, PaginatedMenu, PlayerMenuUtility, etc.) serves as the user interface for viewing and interacting with quests.
- MySQL and Persistence: Represent the “mysql” package which includes MysqlManager and various entity classes (e.g., Quests, Requirements, KilledEntities). In addition, note the project’s support for SQLite (as seen in the config.yml).
- Storylines Module: For managing quests that are narrative-based, including NPC interactions (integrations with external NPC plugins like FancyNpcs or Citizens).
- Utilities and External Integrations: Under “utils” you see support for features such as dynamic placeholder expansion, chat management, and integration points with external systems (e.g., Vault for monetary rewards).

##### Interrelationships and Data Flow
- Command Module to the Quest Manager and the Configuration Manager since commands typically trigger quest-related actions or need configuration data.
- That the Listeners feed game events (player join, kill events, etc.) to the Quest Manager, triggering updates or checks on quest progress.
- Link the Configuration Manager with both the Quest Manager and the Categories subsystem, emphasizing that changes in configuration files affect runtime behavior.
- Persistence layer by showing that the Quest Manager (and possibly the Requirements Manager) interacts with the MySQL Manager to read/write player progress and quest data.

## Diagram (Mermaid)

```mermaid
flowchart TD
    A["Core Plugin"]:::core
    B["Command Handling System"]:::module
    C["Configuration Manager"]:::module
    D["Quest Manager"]:::module
    E["Categories Manager"]:::module
    F["Requirements Manager"]:::module
    G["General Listeners"]:::module
    H["Storylines Listeners"]:::module
    I["Menu Listener"]:::module
    J["Menu and UI System"]:::module
    K["Mysql Manager"]:::module
    L["MySQL Entities"]:::module
    M["Storylines Manager"]:::module
    N["Storylines Models"]:::module
    O["Message Class"]:::module
    P["Utilities & External Integrations"]:::module
    Q["config.yml"]:::conf
    R["quests.yml"]:::conf
    S["categories.yml"]:::conf
    T["storylines.yml"]:::conf
    U["messages.properties"]:::conf

    %% Core Plugin initiates all modules
    A -->|"init"| B
    A -->|"init"| C
    A -->|"init"| D
    A -->|"init"| E
    A -->|"init"| F
    A -->|"init"| G
    A -->|"init"| H
    A -->|"init"| I
    A -->|"init"| J
    A -->|"init"| K
    A -->|"init"| M
    A -->|"init"| P

    %% Command Handling triggers quest actions
    B -->|"triggers"| D
    B -->|"triggers"| E

    %% Configuration Files flow into Config Manager
    Q -->|"loads"| C
    R -->|"loads"| C
    S -->|"loads"| C
    T -->|"loads"| C
    U -->|"loads"| C

    %% Config Manager influences Quest and Category Systems
    C -->|"feeds"| D
    C -->|"feeds"| E

    %% Event Listeners update quests and UI
    G -->|"updates"| D
    H -->|"updates"| D
    I -->|"updates"| J

    %% Persistence interconnections
    D -->|"persists"| K
    F -->|"persists"| K
    K -->|"handles"| L

    %% Storylines interactions and data modeling
    M -->|"persists"| K
    M -->|"models"| N
    N -->|"includes"| O

    %% External integrations for quests and storylines
    P -->|"integrates"| D
    P -->|"integrates"| M

    %% Additional internal link between Quest Manager and Categories Manager
    D -->|"combined"| E

    %% Click Events
    click A "https://github.com/frinshhd/anturniaquests/blob/main/src/main/java/de/frinshhd/anturniaquests/Main.java"
    click B "https://github.com/frinshhd/anturniaquests/tree/main/src/main/java/de/frinshhd/anturniaquests/commands"
    click C "https://github.com/frinshhd/anturniaquests/blob/main/src/main/java/de/frinshhd/anturniaquests/config/ConfigManager.java"
    click Q "https://github.com/frinshhd/anturniaquests/blob/main/src/main/resources/config.yml"
    click R "https://github.com/frinshhd/anturniaquests/blob/main/src/main/resources/quests.yml"
    click S "https://github.com/frinshhd/anturniaquests/blob/main/src/main/resources/categories.yml"
    click T "https://github.com/frinshhd/anturniaquests/blob/main/src/main/resources/storylines.yml"
    click U "https://github.com/frinshhd/anturniaquests/blob/main/src/main/resources/messages.properties"
    click D "https://github.com/frinshhd/anturniaquests/blob/main/src/main/java/de/frinshhd/anturniaquests/quests/QuestsManager.java"
    click E "https://github.com/frinshhd/anturniaquests/blob/main/src/main/java/de/frinshhd/anturniaquests/categories/CategoriesManager.java"
    click F "https://github.com/frinshhd/anturniaquests/tree/main/src/main/java/de/frinshhd/anturniaquests/requirements"
    click G "https://github.com/frinshhd/anturniaquests/tree/main/src/main/java/de/frinshhd/anturniaquests/listener"
    click H "https://github.com/frinshhd/anturniaquests/tree/main/src/main/java/de/frinshhd/anturniaquests/storylines/listener"
    click I "https://github.com/frinshhd/anturniaquests/blob/main/src/main/java/de/frinshhd/anturniaquests/menusystem/MenuListener.java"
    click J "https://github.com/frinshhd/anturniaquests/tree/main/src/main/java/de/frinshhd/anturniaquests/menusystem"
    click K "https://github.com/frinshhd/anturniaquests/blob/main/src/main/java/de/frinshhd/anturniaquests/mysql/MysqlManager.java"
    click L "https://github.com/frinshhd/anturniaquests/tree/main/src/main/java/de/frinshhd/anturniaquests/mysql/entities"
    click M "https://github.com/frinshhd/anturniaquests/blob/main/src/main/java/de/frinshhd/anturniaquests/storylines/StorylinesManager.java"
    click N "https://github.com/frinshhd/anturniaquests/tree/main/src/main/java/de/frinshhd/anturniaquests/storylines/models"
    click O "https://github.com/frinshhd/anturniaquests/blob/main/src/main/java/de/frinshhd/anturniaquests/storylines/Message.java"
    click P "https://github.com/frinshhd/anturniaquests/tree/main/src/main/java/de/frinshhd/anturniaquests/utils"

    %% Styles
    classDef core fill:#ffcccc,stroke:#aa0000,stroke-width:2px;
    classDef module fill:#ccffcc,stroke:#006600,stroke-width:1px;
    classDef conf fill:#ffffcc,stroke:#999900,stroke-width:1px;
```
