# rhydium/rkitpvp architecture

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

- Interactive diagram: https://gitdiagram.com/rhydium/rkitpvp
- Repository: https://github.com/rhydium/rkitpvp

## Overview

##### Project type and purpose
- This is a Java‑based Minecraft server plugin (Spigot/Bukkit API) named rKitPvP, designed to provide a lightweight, fully customizable KitPvP minigame. Its core functions include command handling, event listening, region management (via WorldGuard), player stats, combat logging prevention, scoreboard updates, and coin rewards.

##### File structure
- Top‑level build and CI files:
- Gradle wrapper and build.gradle / settings.gradle (build & dependency management)
- .github/workflows/gradle.yml (CI build/test)
- src/main/java/me/rhydium/rKitPvP
- rKitPvP.java – plugin main (entry point)
- commands/… – command executors (e.g., KitPvPCommand, SetSpawnCommand)
- listeners/… – event handlers (PlayerJoinListener, PvPListener, etc.)
- managers/… – business‑logic components (CombatManager, DatabaseManager, SpawnManager, PlayerStatsManager, ScoreboardManager, CustomConfigManager)
- utils/… – helper modules (WorldGuardUtils, AntiGriefUtility, GUI builder, TabCompleter)
- src/main/resources
- plugin.yml (plugin metadata & command registration)
- config.yml (user‑configurable settings: combat, coins, regions, DB)

##### README for additional insights
- Highlights external dependencies: PlaceholderAPI, WorldEdit, WorldGuard.
- Describes features (scoreboard, custom respawn, coin system, anti‑logging).
- Shows a sample config.yml (revealing the data model and config‑driven architecture).
- Clarifies this is a single‑module plugin, not a web or desktop app.

## Diagram (Mermaid)

```mermaid
flowchart TD
    Server["Minecraft Server"]:::external
    subgraph "rKitPvP Plugin"
        Main["Plugin Main\n(rKitPvP.java)"]:::core

        subgraph "Commands"
            BuildCmd["BuildCommand"]:::command
            KitCmd["KitPvPCommand"]:::command
            SetPvPRegionCmd["SetPvPRegionCommand"]:::command
            SetSpawnCmd["SetSpawnCommand"]:::command
            SetSpawnRegionCmd["SetSpawnRegionCommand"]:::command
            SpawnCmd["SpawnCommand"]:::command
        end

        subgraph "Listeners"
            PlayerCmdListener["PlayerCommandListener"]:::listener
            PlayerJoin["PlayerJoinListener"]:::listener
            PlayerQuit["PlayerQuitListener"]:::listener
            PvPListener["PvPListener"]:::listener
        end

        subgraph "Managers"
            CombatMgr["CombatManager"]:::manager
            ConfigMgr["CustomConfigManager"]:::manager
            DBMgr["DatabaseManager"]:::manager
            StatsMgr["PlayerStatsManager"]:::manager
            ScoreboardMgr["PlayerScoreboardManager"]:::manager
            SpawnMgr["SpawnManager"]:::manager
        end

        subgraph "Utilities"
            WGUtils["WorldGuardUtils"]:::util
            AntiGrief["AntiGriefUtility"]:::util
            TabComp["KitPvPTabCompleter"]:::util
            GUI["KitSelectorGUI"]:::util
        end

        ConfigFile["config.yml"]:::config
        PluginYml["plugin.yml"]:::config
    end

    subgraph "External Dependencies"
        WorldGuardAPI["WorldGuard API"]:::external
        PlaceholderAPI["PlaceholderAPI"]:::external
        WorldEdit["WorldEdit"]:::external
    end

    DB["Database\n(SQLite/MySQL)"]:::external

    %% Connections
    Server --> Main
    Main -->|"load config"| ConfigMgr
    Main -->|"register Commands"| BuildCmd
    Main --> KitCmd
    Main --> SetPvPRegionCmd
    Main --> SetSpawnCmd
    Main --> SetSpawnRegionCmd
    Main --> SpawnCmd
    Main -->|"register Listeners"| PlayerCmdListener
    Main --> PlayerJoin
    Main --> PlayerQuit
    Main --> PvPListener

    BuildCmd -->|"execute"| CombatMgr
    KitCmd -->|"execute"| StatsMgr
    SetPvPRegionCmd -->|"execute"| ConfigMgr
    SetSpawnCmd -->|"execute"| SpawnMgr
    SetSpawnRegionCmd -->|"execute"| ConfigMgr
    SpawnCmd -->|"execute"| SpawnMgr

    PlayerJoin --> StatsMgr
    PlayerQuit --> DBMgr
    PlayerCmdListener --> CombatMgr
    PvPListener --> CombatMgr

    CombatMgr --> DBMgr
    StatsMgr --> DBMgr
    ScoreboardMgr --> StatsMgr
    SpawnMgr --> ConfigMgr

    ConfigMgr --> ConfigFile
    DBMgr --> DB
    ScoreboardMgr --> Server

    WGUtils --> CombatMgr
    WGUtils --> SpawnMgr
    WorldGuardAPI --> WGUtils

    PlaceholderAPI --> ScoreboardMgr
    WorldEdit --> WGUtils

    %% Click Events
    click Main "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/rKitPvP.java"
    click BuildCmd "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/commands/BuildCommand.java"
    click KitCmd "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/commands/KitPvPCommand.java"
    click SetPvPRegionCmd "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/commands/SetPvPRegionCommand.java"
    click SetSpawnCmd "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/commands/SetSpawnCommand.java"
    click SetSpawnRegionCmd "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/commands/SetSpawnRegionCommand.java"
    click SpawnCmd "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/commands/SpawnCommand.java"
    click PlayerCmdListener "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/listeners/PlayerCommandListener.java"
    click PlayerJoin "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/listeners/PlayerJoinListener.java"
    click PlayerQuit "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/listeners/PlayerQuitListener.java"
    click PvPListener "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/listeners/PvPListener.java"
    click CombatMgr "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/managers/CombatManager.java"
    click ConfigMgr "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/managers/CustomConfigManager.java"
    click DBMgr "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/managers/DatabaseManager.java"
    click StatsMgr "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/managers/PlayerStatsManager.java"
    click ScoreboardMgr "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/managers/PlayerScoreboardManager.java"
    click SpawnMgr "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/managers/SpawnManager.java"
    click WGUtils "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/utils/WorldGuardUtils.java"
    click AntiGrief "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/utils/AntiGriefUtility.java"
    click TabComp "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/utils/KitPvPTabCompleter.java"
    click GUI "https://github.com/rhydium/rkitpvp/blob/main/src/main/java/me/rhydium/rKitPvP/utils/KitSelectorGUI.java"
    click PluginYml "https://github.com/rhydium/rkitpvp/blob/main/src/main/resources/plugin.yml"
    click ConfigFile "https://github.com/rhydium/rkitpvp/blob/main/src/main/resources/config.yml"

    classDef core fill:#f9f,stroke:#333,stroke-width:1px
    classDef command fill:#9f9,stroke:#333,stroke-width:1px
    classDef listener fill:#99f,stroke:#333,stroke-width:1px
    classDef manager fill:#ff9,stroke:#333,stroke-width:1px
    classDef util fill:#f99,stroke:#333,stroke-width:1px
    classDef config fill:#9ff,stroke:#333,stroke-width:1px
    classDef external fill:#ccc,stroke:#333,stroke-width:1px
```
