# exceptedprism3/logger architecture

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

- Interactive diagram: https://gitdiagram.com/exceptedprism3/logger
- Repository: https://github.com/exceptedprism3/logger

## Overview

##### Project type and purpose
- This is an open-source, multi-module Java plugin suite (“Logger”) for Minecraft servers. It provides logging of in-game events (chat, commands, block actions, player activity, server stats) and can push logs to SQLite, external databases or Discord. There are three platform modules: BungeeCord proxy, Spigot (Bukkit) server, and Velocity proxy.

##### File structure
- Root module (pom.xml) aggregates sub-modules:
- Logger-BungeeCord (plugin for BungeeCord proxy)
- Logger-Spigot (plugin for Bukkit-based servers)
- Logger-Velocity (plugin for Velocity proxy)
- Logger-Shaded (builds an uber-jar with shaded dependencies)
- Each sub-module follows the same package layout:
– Main entry point (Logger.java)
– api (interfaces/adapters for external plugins: LiteBans, PartyAndFriends, etc.)
– commands (DiscordCMD, Reload, user commands)
– events (listeners for Chat, Login, Leave, server-side events, plug-independent events for other plugins)
– database (SQLite + “external” database support: ExternalData, ExternalUpdater)
– discord (Discord integration classes)
– serverside (internal commands: Start, Stop, RAM, Console)
– utils (ConfigManager, FileHandler, Messages, Metrics, ASCIIArt, UpdateChecker)
– resources (YAML config templates, messages, plugin.yml)

##### README for additional insights
- Describes features: logging various player/server events, supports MySQL (external DB) and SQLite, Discord integration, bStats metrics.

##### Main components
A. Platform Hosts (three parallel environments):
- BungeeCord Proxy
- Velocity Proxy
- Spigot/Bukkit Server
B. Plugin Loader & Initialization
- Reads YAML configs via ConfigManager
- Registers event listeners on the host’s event bus
- Initializes Metrics (bStats) and UpdateChecker
C. Event Manager
- OnEvent handlers (Chat, Command, Join, Leave, Death, BlockPlace, etc.)
- Plug-independent listeners (hook into other plugins via api adapters)
D. Command Manager
- In-game and console commands (Discord toggle, Reload, Dump, Stats commands)
E. Logging Engine & Data Model
- Data classes (Data, SQLiteData, ExternalData) represent events
- Repository/DAO layers (SQLite, ExternalUpdater) persist logs
F. Persistence Layer
- SQLite (embedded) via JDBC
- External DB support (MySQL) via ExternalUpdater
G. Discord Integration Layer
- Builds Discord messages (Discord, DiscordFile, DiscordStatus)
- Sends via Webhook/API
H. Utils & Supporting Services
- FileHandler (manages log files)
- ASCIIArt, Messages (presentation)
- UpdateChecker (self-update alerts)

##### Relationships and data flow
- Platform Host → PluginLoader
- PluginLoader → ConfigManager, Metrics, EventManager, CommandManager
- Event triggers on host → EventManager → LoggingEngine →
- Repository → SQLite or External DB
- DiscordLayer → Discord webhook
- Commands (in-game/console) → CommandManager → LoggingEngine or PluginLoader (reload)
- Utils invoked by all layers for I/O, messaging, metrics

##### Architectural patterns & design principles
- Modular multi-module Maven build for each platform
- Event-driven architecture consistent across modules
- Repository/DAO pattern for persistence
- Adapter pattern for external plugin integration (api package)
- Separation of concerns: init, events, commands, persistence, integration

##### Detail
- Subsystem (init, events, commands, DB, Discord, utils)
- Three platform targets as parallel lanes or separate modules
- Maven multi-module relationship if desired (root pom → child modules)

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Platform Hosts"
        BCD["BungeeCord Proxy"]:::host
        SPG["Spigot/Bukkit Server"]:::host
        VLT["Velocity Proxy"]:::host
    end

    subgraph "Plugin Loader & Initialization"
        PL["PluginLoader"]:::init
        CM_B["ConfigManager (Bungee)"]:::config
        CM_S["ConfigManager (Spigot)"]:::config
        CM_V["ConfigManager (Velocity)"]:::config
        M_B["Metrics (Bungee)"]:::init
        M_S["Metrics (Spigot)"]:::init
        M_V["Metrics (Velocity)"]:::init
        UC["UpdateChecker"]:::init
    end

    subgraph "Event & Command Management"
        EM_B["EventManager (Bungee)"]:::event
        EM_S["EventManager (Spigot)"]:::event
        EM_V["EventManager (Velocity)"]:::event
        CMD_B["CommandManager (Bungee)"]:::command
        CMD_S["CommandManager (Spigot)"]:::command
        CMD_V["CommandManager (Velocity)"]:::command
    end

    subgraph "Logging Engine & Data Model"
        LE["LoggingEngine"]:::core
        DM["DataModel"]:::core
    end

    subgraph "Persistence Layer"
        SQL["SQLite"]:::storage
        EXTU["ExternalUpdater"]:::storage
    end

    subgraph "Discord Integration"
        DCL["Discord Layer"]:::external
    end

    subgraph "Utils & Supporting Services"
        FH["FileHandler"]:::utils
        AM["ASCIIArt/Messages"]:::utils
    end

    BCD --> PL
    SPG --> PL
    VLT --> PL

    PL --> CM_B
    PL --> CM_S
    PL --> CM_V
    PL --> M_B
    PL --> M_S
    PL --> M_V
    PL --> UC
    PL --> EM_B
    PL --> EM_S
    PL --> EM_V
    PL --> CMD_B
    PL --> CMD_S
    PL --> CMD_V

    EM_B --> LE
    EM_S --> LE
    EM_V --> LE

    CMD_B --> LE
    CMD_S --> LE
    CMD_V --> LE

    LE --> DM
    DM --> SQL
    DM --> EXTU
    LE --> DCL

    FH --> PL
    FH --> EM_B
    FH --> EM_S
    FH --> EM_V
    FH --> LE
    AM --> PL
    AM --> EM_B
    AM --> EM_S
    AM --> EM_V
    AM --> LE

    click BCD "https://github.com/exceptedprism3/logger/blob/Improving/Logger-BungeeCord/src/main/java/me/prism3/loggerbungeecord/Logger.java"
    click SPG "https://github.com/exceptedprism3/logger/blob/Improving/Logger-Spigot/src/main/java/me/prism3/logger/Logger.java"
    click VLT "https://github.com/exceptedprism3/logger/blob/Improving/Logger-Velocity/src/main/java/me/prism3/loggervelocity/Logger.java"
    click CM_B "https://github.com/exceptedprism3/logger/blob/Improving/Logger-BungeeCord/src/main/java/me/prism3/loggerbungeecord/utils/ConfigManager.java"
    click CM_S "https://github.com/exceptedprism3/logger/blob/Improving/Logger-Spigot/src/main/java/me/prism3/logger/utils/ConfigManager.java"
    click CM_V "https://github.com/exceptedprism3/logger/blob/Improving/Logger-Velocity/src/main/java/me/prism3/loggervelocity/utils/ConfigManager.java"
    click M_B "https://github.com/exceptedprism3/logger/blob/Improving/Logger-BungeeCord/src/main/java/me/prism3/loggerbungeecord/utils/Metrics.java"
    click M_S "https://github.com/exceptedprism3/logger/blob/Improving/Logger-Spigot/src/main/java/me/prism3/logger/utils/Metrics.java"
    click M_V "https://github.com/exceptedprism3/logger/blob/Improving/Logger-Velocity/src/main/java/me/prism3/loggervelocity/utils/Metrics.java"
    click UC "https://github.com/exceptedprism3/logger/blob/Improving/Logger-BungeeCord/src/main/java/me/prism3/loggerbungeecord/utils/UpdateChecker.java"
    click EM_B "https://github.com/exceptedprism3/logger/tree/Improving/Logger-BungeeCord/src/main/java/me/prism3/loggerbungeecord/events"
    click EM_S "https://github.com/exceptedprism3/logger/tree/Improving/Logger-Spigot/src/main/java/me/prism3/logger/events"
    click EM_V "https://github.com/exceptedprism3/logger/tree/Improving/Logger-Velocity/src/main/java/me/prism3/loggervelocity/events"
    click CMD_B "https://github.com/exceptedprism3/logger/tree/Improving/Logger-BungeeCord/src/main/java/me/prism3/loggerbungeecord/commands"
    click CMD_S "https://github.com/exceptedprism3/logger/blob/Improving/Logger-Spigot/src/main/java/me/prism3/logger/commands/CommandManager.java"
    click CMD_V "https://github.com/exceptedprism3/logger/tree/Improving/Logger-Velocity/src/main/java/me/prism3/loggervelocity/commands"
    click DM "https://github.com/exceptedprism3/logger/blob/Improving/Logger-BungeeCord/src/main/java/me/prism3/loggerbungeecord/utils/Data.java"
    click SQL "https://github.com/exceptedprism3/logger/blob/Improving/Logger-BungeeCord/src/main/java/me/prism3/loggerbungeecord/database/sqlite/SQLite.java"
    click EXTU "https://github.com/exceptedprism3/logger/blob/Improving/Logger-BungeeCord/src/main/java/me/prism3/loggerbungeecord/database/external/ExternalUpdater.java"
    click DCL "https://github.com/exceptedprism3/logger/tree/Improving/Logger-BungeeCord/src/main/java/me/prism3/loggerbungeecord/discord"
    click FH "https://github.com/exceptedprism3/logger/blob/Improving/Logger-BungeeCord/src/main/java/me/prism3/loggerbungeecord/utils/FileHandler.java"
    click AM "https://github.com/exceptedprism3/logger/blob/Improving/Logger-BungeeCord/src/main/java/me/prism3/loggerbungeecord/utils/ASCIIArt.java"

    classDef host fill:#D0E6FF,stroke:#036CFE,stroke-width:1px
    classDef init fill:#E8F0FE,stroke:#6C7A89,stroke-width:1px
    classDef config fill:#FFF4D6,stroke:#C49B3B,stroke-width:1px
    classDef event fill:#E2F8E5,stroke:#3AA76D,stroke-width:1px
    classDef command fill:#D0F0FF,stroke:#1BA1E2,stroke-width:1px
    classDef core fill:#FFE8E8,stroke:#E24C4B,stroke-width:1px
    classDef storage fill:#FFF0E1,stroke:#E68A00,stroke-width:1px
    classDef external fill:#F0E5FF,stroke:#8E44AD,stroke-width:1px
    classDef utils fill:#F2F2F2,stroke:#A0A0A0,stroke-width:1px
```
