# alexandrebarde/pluginopenmc architecture

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

- Interactive diagram: https://gitdiagram.com/alexandrebarde/pluginopenmc
- Repository: https://github.com/alexandrebarde/pluginopenmc

## Overview

##### Project Type and Purpose
- This is a monolithic Java plugin (“Plugin OpenMC”) for a Minecraft server (Spigot/Paper).
- It follows the Bukkit API event-driven model: on startup it registers commands and listeners, handles player interactions, and persists data via database or YAML files.

##### File Structure Analysis
- Top-level build files: build.gradle, settings.gradle, gradle wrapper → standard Gradle-based Java project.
- src/main/java/fr/communaywen/core/AywenCraftPlugin.java → plugin’s main class.
- Packages under core:
- commands/… → individual command handlers (e.g., FeedCommand, MoneyCommand)
- listeners/… → event listeners (e.g., ChatListener, ExplosionListener)
- economy/, friends/, teams/, tpa/ → domain-specific managers and data classes
- utils/… → low-level helpers (DatabaseManager, DiscordWebhook, GitHubAPI, etc.)
- src/main/resources: plugin.yml (plugin metadata), config.yml + quizzes.yml + other YAMLs for runtime config.

##### README Insights
- Confirms collaborative plugin development for a live “dev.openmc.fr” server.

##### Main Components
a. Minecraft Server (Spigot/Paper)
b. Plugin Core
- Bootstrap (AywenCraftPlugin)
- Command Registry (all commands in commands/)
- Event Dispatcher (all listeners in listeners/)
c. Domain Managers
- EconomyManager & EconomyData
- FriendsManager & FriendsRequest
- QuizManager
- TeamManager & Team data
- TPAQueue
- ScoreboardManagers
d. Persistence & Config
- DatabaseManager → relational or embedded database (via DatabaseConnection)
- YAML storages (config.yml, quizzes.yml, rules.yml, …)
e. Utility/Integration Layer
- DiscordWebhook
- GitHubAPI, DraftAPI, LinkerAPI
- MOTDChanger, PermissionCategory, ItemBuilder, etc.
f. External Services
- Discord
- GitHub
- (Potential other HTTP APIs)

##### Component Relationships & Data Flows
- On plugin load, AywenCraftPlugin reads YAML config → initializes DatabaseManager → registers commands & listeners.
- Player issues a command → Command Dispatcher invokes specific Command class → uses Domain Managers or Utils → may read/write to database or config.
- In-game events → Event Dispatcher sends events to Listeners → they call Domain Managers or Utils (e.g., Insomnia listener sets player state).
- Managers persist data via DatabaseManager or update YAML files.
- Some commands/utilities call External Services via HTTP (DiscordWebhook, GitHubAPI).

##### Architectural Patterns & Principles
- Event-Driven (Bukkit’s listener model)
- Command Pattern (each plugin command is its own class)
- Layered Architecture:
1) API Layer (commands, listeners)
2) Service Layer (managers)
3) Data Layer (DatabaseManager + YAML config)
4) Integration Layer (external HTTP APIs)
- Single Responsibility: each class handles one behavior (e.g., “FreezeCommand” vs “FreezeListener” vs “FreezeUtils”).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Layers
    subgraph "Minecraft Server" 
        MS["Spigot/Paper Server"] 
    end

    subgraph "Plugin Core" 
        direction TB
        AP["AywenCraftPlugin"]:::pluginCore
        CR["Command Registry\n(24 command handlers)"]:::pluginCore
        ED["Event Dispatcher\n(listeners)"]:::pluginCore
    end

    subgraph "Domain Managers" 
        direction TB
        EM["EconomyManager\n& EconomyData"]:::domain
        FM["FriendsManager\n& FriendsRequest"]:::domain
        QM["QuizManager"]:::domain
        TM["TeamManager\n& Team"]:::domain
        TQ["TPAQueue"]:::domain
        SM["ScoreboardManagers"]:::domain
    end

    subgraph "Data Storage & Config" 
        direction TB
        DB["Database\n(DatabaseConnection & DatabaseManager)"]:::storage
        subgraph "YAML Configs" 
            direction TB
            C1["config.yml"]:::storage
            C2["quizzes.yml"]:::storage
            C3["rules.yml"]:::storage
            C4["welcomeMessageConfig.yml"]:::storage
            C5["plugin.yml"]:::storage
        end
    end

    subgraph "Utilities & Integration" 
        direction TB
        DW["DiscordWebhook"]:::utils
        GH["GitHubAPI"]:::utils
        DR["DraftAPI"]:::utils
        LR["LinkerAPI"]:::utils
        MC["MOTDChanger"]:::utils
        PC["PermissionCategory"]:::utils
        IB["ItemBuilder"]:::utils
    end

    subgraph "External Services" 
        direction TB
        D["Discord"]:::external
        G["GitHub"]:::external
        H["Other HTTP APIs"]:::external
    end

    %% Connections
    MS -->|"bootstrap"| AP
    AP -->|"registers commands"| CR
    AP -->|"registers listeners"| ED

    CR -->|"invokes"| EM
    CR -->|"invokes"| FM
    CR -->|"invokes"| QM
    CR -->|"invokes"| TM
    CR -->|"invokes"| TQ
    CR -->|"invokes"| SM

    ED -->|"onEvent"| EM
    ED -->|"onEvent"| FM
    ED -->|"onEvent"| QM
    ED -->|"onEvent"| TM
    ED -->|"onEvent"| TQ
    ED -->|"onEvent"| SM

    EM -->|"SQL Query"| DB
    FM -->|"SQL Query"| DB
    QM -->|"YAML read/write"| C2
    TM -->|"SQL Query"| DB
    TQ -->|"SQL Query"| DB
    SM -->|"SQL Query"| DB

    CR -->|"HTTP POST"| DW
    CR -->|"HTTP GET/POST"| GH
    CR -->|"HTTP GET/POST"| DR
    CR -->|"HTTP GET/POST"| LR

    ED -->|"uses"| MC
    ED -->|"uses"| PC
    ED -->|"uses"| IB

    DW -->|"webhook"| D
    GH -->|"REST"| G
    DR -->|"REST"| H
    LR -->|"REST"| H

    %% Click Events
    click AP "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/AywenCraftPlugin.java"
    click CR "https://github.com/alexandrebarde/pluginopenmc/tree/main/src/main/java/fr/communaywen/core/commands/"
    click ED "https://github.com/alexandrebarde/pluginopenmc/tree/main/src/main/java/fr/communaywen/core/listeners/"
    click EM "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/economy/EconomyManager.java"
    click EM "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/economy/EconomyData.java"
    click FM "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/friends/FriendsManager.java"
    click FM "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/friends/FriendsRequest.java"
    click QM "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/QuizManager.java"
    click TM "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/teams/TeamManager.java"
    click TM "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/teams/Team.java"
    click TQ "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/tpa/TPAQueue.java"
    click SM "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/scoreboard/ScoreboardManagers.java"
    click DB "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/utils/database/DatabaseConnection.java"
    click DB "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/utils/database/DatabaseManager.java"
    click C1 "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/resources/config.yml"
    click C2 "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/resources/quizzes.yml"
    click C3 "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/resources/rules.yml"
    click C4 "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/resources/welcomeMessageConfig.yml"
    click C5 "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/resources/plugin.yml"
    click DW "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/utils/DiscordWebhook.java"
    click GH "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/utils/GitHubAPI.java"
    click DR "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/utils/DraftAPI.java"
    click LR "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/utils/LinkerAPI.java"
    click MC "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/utils/MOTDChanger.java"
    click PC "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/utils/PermissionCategory.java"
    click IB "https://github.com/alexandrebarde/pluginopenmc/blob/main/src/main/java/fr/communaywen/core/utils/ItemBuilder.java"

    %% Styles
    classDef pluginCore fill:#b3e6b3,stroke:#2e7d32,color:#000;
    classDef domain fill:#bbdefb,stroke:#1565c0,color:#000;
    classDef storage fill:#e0e0e0,stroke:#424242,color:#000;
    classDef utils fill:#fff9c4,stroke:#f9a825,color:#000;
    classDef external fill:#ffe0b2,stroke:#e65100,color:#000;
```
