Configuration
Full config.yml breakdown with all settings, display templates, and message customisation.
Overview
All configuration lives in config.yml inside the /plugins/VaultLeaderboards/ directory.
After making changes, run /vl reload to apply them without restarting the server.
Placeholder Templates
Customise how leaderboard data is displayed using MiniMessage formatting and template variables:
| Option | Default | Description |
|---|---|---|
| placeholders.top | <yellow><rank>. <green><player></green> - <aqua>$<balance> | Format for each line in the top leaderboard |
| placeholders.player | <yellow><player></yellow> is <green>#<rank></green> with <aqua>$<balance> | Format for individual player rank display |
| placeholders.server-average | <yellow>Server Average: <aqua>$<balance> | Format for server average balance |
| placeholders.not-available | <red>N/A</red> | Fallback when data is unavailable |
| placeholders.top-earner | <yellow><rank>. <green><player></green> +<aqua>$<amount></aqua> (<days>d) | Format for time-based top earner display |
Available template variables: <rank>, <player>, <balance>, <amount>, <days>
Messages
Customise all plugin chat messages:
| Option | Default | Description |
|---|---|---|
| messages.prefix | <dark_gray>[<gold>VL</gold>]</dark_gray> | Chat prefix for all plugin messages |
| messages.no-permission | <red>You lack permission for this command.</red> | No-permission message |
| messages.reload | <green>Configuration reloaded!</green> | Reload confirmation message |
| messages.version.available | <yellow>New version available: <green><new-version></green> | Update available notification |
| messages.version.up-to-date | <green>You are running the latest version!</green> | Up-to-date message |
Settings
| Option | Default | Description |
|---|---|---|
| settings.debug | false | Enable debug logging (logs each player's balance on refresh) |
| settings.refresh-interval | 60 | Seconds between leaderboard data refreshes |
| settings.top-limit | 10 | Maximum number of players 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 |
Database
See the Database Mode page for the full database configuration reference including host, port, credentials, connection pool, and sync settings.