Operator-first documentation for the HM Stats platform.
The primary audience is clan and community administrators, not developers.
The recommended reading order for a new installation is:
- Installation
- Domain & HTTPS
- OIDC administrator login
- Dashboard
- API Keys
- Servers & Seasons
- Client installation & configuration
- Troubleshooting
This repository is the public documentation and API contract source for:
- installation and self-hosting
- domain/TLS and OIDC configuration
- dashboard administration
- client installation and configuration
- security and operational guidance
- REST API reference
- OpenAPI v1
- contributor/development notes
- Client: https://github.com/henrymmey/minecraft-stats-client
- Server: https://github.com/henrymmey/minecraft-stats-server
- Dashboard: https://github.com/henrymmey/minecraft-stats-dashboard
- Documentation: https://github.com/henrymmey/minecraft-stats-docs
The HM Stats client targets Minecraft 26.2, Java 25 and Fabric Loader 0.19.3 or newer.
MIT.