README.md

Minecraft Server Metrics & Chat Bot

Requirements

• uv

Setup

Copy .env.example to .env and fill in your details:

• DISCORD_TOKEN: Your Discord bot token
• STATS_CHANNEL_ID: Channel ID for the system stats widget
• CHAT_CHANNEL_ID: Channel ID for the Minecraft chat logs
• MC_LOG_DIR: Path to the Minecraft server logs/ directory

Run

uv run src/main.py

Dev Server (Testing)

Run this script to simulate a Minecraft server writing fake chat logs to ./logs:

uv run python dev_fake_server.py

Development

To format and lint the code (and automatically apply fixes):

uv run ruff format .
uv run ruff check . --fix

To run static type checking:

uv run mypy .