📊 Stats & Reports
Stats module tracks server performance metrics (TPS, player count) and sends automated daily reports to a Discord channel.
To enable: set
enableStats: true in general.json. Configure the report channel in stats.json.
Jump to
📈 Overview
Voidium samples player count every minute and tracks:
- Peak players — highest online count in the last 24 hours
- Average players — mean online count over the period
- TPS — real-time ticks per second via
TpsTracker
The data is kept in memory for the current reporting period and reset after the daily report is sent.
⚙️ Configuration
File: config/voidium/stats.json
| Field | Type | Default | Description |
|---|---|---|---|
enableStats |
boolean | true |
Master switch |
reportChannelId |
string | "" |
Discord channel ID for daily reports |
reportTime |
string | "09:00" |
Time of day to send the report (HH:mm, 24h) |
reportTitle |
string | 📊 Daily Statistics - %date% |
Embed title. Placeholder: %date% |
reportPeakLabel |
string | Peak Players |
Label for peak field |
reportAverageLabel |
string | Average Players |
Label for average field |
reportFooter |
string | Voidium Stats |
Embed footer text |
Example config
{
"enableStats": true,
"reportChannelId": "1234567890",
"reportTime": "09:00",
"reportTitle": "📊 Daily Statistics - %date%",
"reportPeakLabel": "Peak Players",
"reportAverageLabel": "Average Players",
"reportFooter": "Voidium Stats"
}
📋 Daily report
At the configured reportTime, Voidium sends a Discord embed to reportChannelId:
- Title:
reportTitlewith%date%replaced - Fields: Peak players, Average players
- Color: Cyan
- Footer:
reportFooter
Requirement: Discord module must be enabled and the bot must have permission to send messages in the report channel.
Related
- Discord — bot setup
- Configuration — all config files