# kitaminka/minecraft-server-bot architecture

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

- Interactive diagram: https://gitdiagram.com/kitaminka/minecraft-server-bot
- Repository: https://github.com/kitaminka/minecraft-server-bot

## Overview

##### Project Type and Purpose
- This is an open-source Discord bot written in Go.
- Its main use case is managing a Minecraft server whitelist & authorization via Discord commands.

##### File Structure
Top-level directories and files:
- bot/           – low-level Discord session setup (bot.go)
- connection/    – connectors to DB (db.go), Minecraft plugin (mc_commands.go), player info (player.go), and RCON (rcon.go)
- handlers/      – business logic for commands, components, messages, and modals
- main.go        – entry point where the bot and handlers are wired up
- commands.json  – definition of slash commands
- .env.example   – environment variables (Discord token, DB URL, RCON creds)

##### Extract Key Insights from README
- Integrates with AuthMeReloaded by default (but configurable).
- Requires a database to store whitelist/authorization state.
- Uses Discord slash commands to drive actions.

##### Main Components
a. External Services
– Discord Gateway (via Discord API)
– Minecraft Server (AuthMeReloaded plugin)
– Database (e.g., MySQL/PostgreSQL)
b. Internal Modules
– Bot module (bot/bot.go): initializes Discord session, registers commands
– Handlers (handlers/*.go): respond to incoming interactions/messages
– Connection layer (connection/*.go):
- db.go – CRUD ops on whitelist table
- rcon.go – send RCON commands to Minecraft server
- mc_commands.go – wrapper to AuthMeReloaded commands
- player.go – abstraction over Minecraft player data
– Configuration & Command Definitions
- commands.json – slash command specs
- .env – secrets and endpoints

##### Relationships & Data Flow
1. Discord user invokes a slash command →
2. Discord Gateway forwards interaction to Bot module (bot.go) →
3. Bot module calls appropriate handler (handlers/… .go) →
4. Handler may:
- Query/update the Database (via connection/db.go)
- Issue RCON command to Minecraft server (via connection/rcon.go & mc_commands.go)
5. Handler constructs a response → Bot module sends reply back over Discord API

##### Architectural Patterns & Principles
- Layered architecture:
– Presentation: Discord Gateway & Bot module
– Application: Handlers
– Infrastructure: Connection layer (DB & RCON)
- Single Responsibility: each directory/file has a clear role
- Configuration-driven: commands.json and .env drive runtime behavior
- Modular: easy to swap out AuthMeReloaded for another plugin

##### Essential Elements
- Component names & roles (e.g., “Handler: /send-whitelist”)
- Configuration files (.env, commands.json) as a separate node

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "External Systems"
        Discord["Discord Gateway"]:::external
        Database["Database"]:::external
        MCServer["Minecraft Server (AuthMeReloaded)"]:::external
    end

    subgraph "Discord Integration"
        Bot["Bot Module<br>(bot/bot.go)"]:::core
        CommandsDef["Slash Command Definitions<br>(commands.json)"]:::config
    end

    subgraph "Business Logic"
        HandlersCmd["Handler: commands.go"]:::core
        HandlersComp["Handler: components.go"]:::core
        HandlersAll["Handler: handlers.go"]:::core
        HandlersMsg["Handler: messages.go"]:::core
        HandlersMod["Handler: modals.go"]:::core
    end

    subgraph "Infrastructure"
        DBConn["DB Connector<br>(connection/db.go)"]:::infra
        RCON["RCON Client<br>(connection/rcon.go)"]:::infra
        MCAsk["MC Commands<br>(connection/mc_commands.go)"]:::infra
        Player["Player Abstraction<br>(connection/player.go)"]:::infra
    end

    subgraph "Configuration Files"
        Env["Environment Config<br>(.env.example)"]:::config
        GoMod["go.mod"]:::config
        GoSum["go.sum"]:::config
        Editorconfig[".editorconfig"]:::config
        Gitignore[".gitignore"]:::config
        License["LICENSE"]:::config
        Readme["README.md"]:::config
    end

    Main["Entry Point<br>(main.go)"]:::core

    Discord -->|"HTTP/WebSocket"| Bot
    Bot -->|"invoke"| HandlersCmd
    Bot -->|"invoke"| HandlersComp
    Bot -->|"invoke"| HandlersAll
    Bot -->|"invoke"| HandlersMsg
    Bot -->|"invoke"| HandlersMod

    HandlersCmd -->|"SQL/ORM"| DBConn
    HandlersComp -->|"SQL/ORM"| DBConn
    HandlersAll -->|"SQL/ORM"| DBConn
    HandlersMsg -->|"SQL/ORM"| DBConn
    HandlersMod -->|"SQL/ORM"| DBConn

    HandlersCmd -->|"RCON"| RCON
    HandersCmd -.->|"plugin calls"| MCAsk
    HandlersComp -->|"RCON"| RCON
    HandlersAll -->|"plugin calls"| MCAsk
    HandlersMsg -->|"RCON"| RCON
    HandlersMod -->|"plugin calls"| MCAsk

    DBConn -->|"SQL"| Database
    RCON -->|"RCON"| MCServer
    MCAsk -->|"AuthMe commands"| MCServer
    MCAsk -->|"uses"| Player

    Main --> Bot
    Main --> DBConn
    Main --> RCON
    Main --> MCAsk
    Main --> Player
    Main --> CommandsDef
    Main --> Env

    classDef external fill:#ADD8E6,stroke:#000;
    classDef core fill:#90EE90,stroke:#000;
    classDef infra fill:#98FB98,stroke:#000;
    classDef config fill:#FFA500,stroke:#000;

    click Bot "https://github.com/kitaminka/minecraft-server-bot/blob/main/bot/bot.go"
    click CommandsDef "https://github.com/kitaminka/minecraft-server-bot/blob/main/commands.json"
    click Env "https://github.com/kitaminka/minecraft-server-bot/blob/main/.env.example"
    click Main "https://github.com/kitaminka/minecraft-server-bot/blob/main/main.go"
    click HandlersCmd "https://github.com/kitaminka/minecraft-server-bot/blob/main/handlers/commands.go"
    click HandlersComp "https://github.com/kitaminka/minecraft-server-bot/blob/main/handlers/components.go"
    click HandlersAll "https://github.com/kitaminka/minecraft-server-bot/blob/main/handlers/handlers.go"
    click HandlersMsg "https://github.com/kitaminka/minecraft-server-bot/blob/main/handlers/messages.go"
    click HandlersMod "https://github.com/kitaminka/minecraft-server-bot/blob/main/handlers/modals.go"
    click DBConn "https://github.com/kitaminka/minecraft-server-bot/blob/main/connection/db.go"
    click RCON "https://github.com/kitaminka/minecraft-server-bot/blob/main/connection/rcon.go"
    click MCAsk "https://github.com/kitaminka/minecraft-server-bot/blob/main/connection/mc_commands.go"
    click Player "https://github.com/kitaminka/minecraft-server-bot/blob/main/connection/player.go"
    click GoMod "https://github.com/kitaminka/minecraft-server-bot/blob/main/go.mod"
    click GoSum "https://github.com/kitaminka/minecraft-server-bot/blob/main/go.sum"
    click Editorconfig "https://github.com/kitaminka/minecraft-server-bot/blob/main/.editorconfig"
    click Gitignore "https://github.com/kitaminka/minecraft-server-bot/blob/main/.gitignore"
    click License "https://github.com/kitaminka/minecraft-server-bot/tree/main/LICENSE"
    click Readme "https://github.com/kitaminka/minecraft-server-bot/blob/main/README.md"
```
