# jonagamerpro1234/advancedchat architecture

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

- Interactive diagram: https://gitdiagram.com/jonagamerpro1234/advancedchat
- Repository: https://github.com/jonagamerpro1234/advancedchat

## Overview

##### Project type and purpose
- This is an open-source Minecraft chat customization plugin named “AdvancedChat.”
- It provides a core API plus two platform adapters (Bukkit/Spigot and BungeeCord) to hook into server events, file-based configuration, command processing, chat formatting, permission & hook integrations, and metrics.

##### File structure
- Top-level modules:
– AdvancedChat 1.6.x Bug Fix (core code + tests + resources + pom.xml)
– Bukkit (Spigot/Bukkit adapter with storage implementations)
– Bungee (BungeeCord adapter)
- Core subpackages:
– commands/ (command definitions, subcommands, handler)
– listeners/ (event loader, chat & inventory listeners)
– files/ (config, logs, player data, file utils)
– manager/ (ConfigManager, PlayerManager, HookManager, ColorManager)
– chat/MessageBuilder (format engine)
– hooks/ (interfaces and implementations for Vault, LuckPerms, PlaceholderAPI, DiscordSRV)
– utils/ (logging, update checker, general utilities)
- Resources: YAML files (config, chat.yml, gui definitions), plugin.yml
- Build: Maven (pom.xml), GitHub workflows, Dependabot
- Tests: simple unit test in core module (Main.java)

##### README
- Confirms that AdvancedChat is a plugin that customizes chat on a server.
- Mentions supported MC versions, installation steps, API usage via JitPack.

##### Main components to capture
– Spigot/Bukkit Server
– BungeeCord Proxy
– Core Module
– Bukkit Adapter Module
– Bungee Adapter Module
c. Core Module subcomponents
– EventLoader → registers ChatListener, CommandListener, InventoryListener
– CommandHandler → AdvancedChatCmd, ClearChatCmd, MuteCmd, UnMuteCmd, subcommands
– ChatEngine/MessageBuilder → applies formatting patterns (solid, gradient, rainbow) via IridiumColorAPI
– FileManager & ConfigFile, ChatLogFile, ColorFile, PlayerFile, CommandLogFile
– Managers: ConfigManager, PlayerManager, HookManager, ColorManager
– Hook interfaces & implementers: Vault, LuckPerms, PlaceholderAPI, DiscordSRV
– UpdateChecker & Metrics (bStats)
– Utils: Logger, Utils, InventoryView, TSkullUtils
d. Storage implementations (in Bukkit module)
– YamlStorage, JsonStorage, MySqlStorage (implements IStorage)
e. External services
– Vault (economy/groups), LuckPerms (permissions), PlaceholderAPI (placeholders), DiscordSRV (Discord integration), bStats (metrics)

##### Relationships & data flows
- Server emits an event → EventLoader → appropriate Listener
- Listener → delegates to CommandHandler or ChatEngine
- CommandHandler → invokes business logic, updates PlayerManager or files → returns feedback via MessageBuilder → server
- ChatEngine → loads settings from ConfigManager/FileManager → MessageBuilder → returns formatted chat message → server
- HookManager → checks for and invokes third-party hooks at runtime
- Storage layer (Yaml/JSON/MySQL) is chosen by server admin in config → storage module in Bukkit adapter

##### Architectural patterns & design principles
- Modular plugin design: core + platform adapters
- Event-driven (listeners register with server API)
- Strategy pattern: multiple storage strategies via IStorage
- Hook abstraction: pluggable external integrations via Hook interface
- Separation of concerns: commands, chat formatting, file I/O, hooks, storage

## Diagram (Mermaid)

```mermaid
graph TB
    %% Server Boundary
    subgraph "Minecraft Server" 
        style Minecraft Server fill:#EEE,stroke:#999,stroke-width:2px

        %% Plugin Boundary
        subgraph "AdvancedChat Plugin"
            style AdvancedChat Plugin fill:#FFF,stroke:#666,stroke-width:1px

            %% Core Module
            subgraph "Core Module" 
                style Core Module fill:#9f6,stroke:#333,stroke-width:1px
                AC_Main["AdvancedChatPlugin"] 
                EventLoader["EventLoader"] 
                ChatListener["ChatListener"] 
                CommandListener["CommandListener"] 
                InventoryListener["InventoryListener"] 
                JoinListener["JoinListener"] 
                CommandHandler["CommandHandler"] 
                MessageBuilder["MessageBuilder"] 
                FileManager["FileManager"] 
                ConfigManager["ConfigManager"] 
                PlayerManager["PlayerManager"] 
                HookManager["HookManager"] 
                ColorManager["ColorManager"] 
                UpdateChecker["UpdateChecker"] 
                Metrics["Metrics"]
                HookInterface["Hook Interface"]
            end

            %% Bukkit Adapter
            subgraph "Bukkit Adapter" 
                style Bukkit Adapter fill:#6cf,stroke:#333,stroke-width:1px
                Bukkit_Main["AdvancedChat (Bukkit)"]
                subgraph "Storage Strategies"
                    style Storage Strategies fill:none,stroke:none
                    YamlStorage["YamlStorage"] 
                    JsonStorage["JsonStorage"] 
                    MySqlStorage["MySqlStorage"] 
                    IStorage["IStorage"]
                end
            end

            %% Bungee Adapter
            subgraph "Bungee Adapter"
                style Bungee Adapter fill:#6cf,stroke:#333,stroke-width:1px
                Bungee_Main["AdvancedChat (Bungee)"]
            end
        end

        %% External Services
        subgraph "External Services"
            style External Services fill:none,stroke:none
            Vault["Vault"]:::external
            LuckPerms["LuckPerms"]:::external
            PlaceholderAPI["PlaceholderAPI"]:::external
            DiscordSRV["DiscordSRV"]:::external
            bStats["bStats"]:::external
        end

        %% Storage Resources
        subgraph "Storage Resources"
            style Storage Resources fill:none,stroke:none
            ConfigFile["ConfigFile"]:::storage
            ChatLogFile["ChatLogFile"]:::storage
            ColorFile["ColorFile"]:::storage
            PlayerFile["PlayerFile"]:::storage
            CommandLogFile["CommandLogFile"]:::storage
        end

        %% Data Flows
        MinecraftServer((Minecraft<br/>Server))
        MinecraftServer -->|emits events| EventLoader
        EventLoader --> ChatListener
        EventLoader --> CommandListener
        EventLoader --> InventoryListener
        EventLoader --> JoinListener

        ChatListener -->|delegates| ChatEngine((Chat Engine))
        CommandListener -->|to| CommandHandler
        InventoryListener -->|to| CommandHandler
        JoinListener -->|to| PlayerManager

        CommandHandler -->|business logic| PlayerManager
        CommandHandler -->|writes| FileManager
        CommandHandler -->|formats| MessageBuilder
        ChatEngine -->|formats| MessageBuilder

        MessageBuilder -->|returns message| MinecraftServer

        FileManager --> ConfigFile
        FileManager --> ChatLogFile
        FileManager --> ColorFile
        FileManager --> PlayerFile
        FileManager --> CommandLogFile

        HookManager --> Vault
        HookManager --> LuckPerms
        HookManager --> PlaceholderAPI
        HookManager --> DiscordSRV

        Metrics --> bStats

        %% Adapter interactions
        Bukkit_Main -->|loads core| AC_Main
        Bungee_Main -->|loads core| AC_Main

        Bukkit_Main --> YamlStorage
        Bukkit_Main --> JsonStorage
        Bukkit_Main --> MySqlStorage
        YamlStorage --> IStorage
        JsonStorage --> IStorage
        MySqlStorage --> IStorage

    end

    %% Click Events
    click AC_Main "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/AdvancedChatPlugin.java"
    click EventLoader "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/listeners/EventLoader.java"
    click ChatListener "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/listeners/chat/ChatListener.java"
    click CommandListener "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/listeners/chat/CommandListener.java"
    click InventoryListener "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/listeners/InventoryListener.java"
    click JoinListener "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/listeners/JoinListener.java"
    click CommandHandler "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/commands/CommandHandler.java"
    click MessageBuilder "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/chat/MessageBuilder.java"
    click FileManager "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/files/utils/FileManager.java"
    click ConfigManager "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/manager/ConfigManager.java"
    click PlayerManager "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/manager/PlayerManager.java"
    click HookManager "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/manager/HookManager.java"
    click ColorManager "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/manager/ColorManager.java"
    click Metrics "https://github.com/jonagamerpro1234/advancedchat/blob/main/AdvancedChat 1.6.x Bug Fix/src/main/java/jss/advancedchat/Metrics.java"
    click Bukkit_Main "https://github.com/jonagamerpro1234/advancedchat/blob/main/Bukkit/src/main/java/jss/advancedchat/AdvancedChat.java"
    click YamlStorage "https://github.com/jonagamerpro1234/advancedchat/blob/main/Bukkit/src/main/java/jss/advancedchat/storage/yaml/YamlStorage.java"
    click JsonStorage "https://github.com/jonagamerpro1234/advancedchat/blob/main/Bukkit/src/main/java/jss/advancedchat/storage/json/JsonStorage.java"
    click MySqlStorage "https://github.com/jonagamerpro1234/advancedchat/blob/main/Bukkit/src/main/java/jss/advancedchat/storage/mysql/MySqlStorage.java"
    click IStorage "https://github.com/jonagamerpro1234/advancedchat/blob/main/Bukkit/src/main/java/jss/advancedchat/storage/utils/IStorage.java"

    %% Styles
    classDef core fill:#9f6,stroke:#333
    classDef adapter fill:#6cf,stroke:#333
    classDef external fill:#f96,stroke:#c60,stroke-width:2px
    classDef storage fill:#c69,stroke:#933,stroke-width:2px
```
