Leaderboard Features
Built-in leaderboard display, smart balance formatting, and automatic update checking.
The /vl top Command
Use /vl top [page] to display the top balances leaderboard in chat.
The leaderboard is paginated with 10 players per page by default. If no page number is provided, page 1 is shown.
Each line in the leaderboard uses the configurable template from config.yml, with variables like <rank>, <player>, and <balance>.
Balance Formatting
VaultLeaderboards automatically abbreviates large numbers for readability:
| Balance | Display |
|---|---|
| $1,500.00 | $1.50k |
| $3,200,000.00 | $3.20M |
| $1,000,000,000.00 | $1.00B |
| $5,000,000,000,000.00 | $5.00T |
Update Checker
VaultLeaderboards queries the Modrinth API on startup to check for new versions. If an update is available, OP players are notified on join.
Use /vl version to manually check for updates and see your current version.
Refresh Interval
The leaderboard data refreshes on a configurable interval (default 60 seconds). During each refresh, VaultLeaderboards scans online player balances and updates the in-memory leaderboard.
In database mode, balances are also synced to MySQL during each refresh cycle.
Configuration
| Option | Default | Description |
|---|---|---|
| settings.refresh-interval | 60 | Seconds between leaderboard data refreshes |
| settings.top-limit | 10 | Maximum number of players shown in leaderboard queries |
| settings.check-updates | true | Enable automatic update checking via Modrinth API |
| settings.notify-op-updates | true | Notify OP players of updates on join |
| settings.debug | false | Enable debug logging (logs each player's balance on refresh) |