Integrations
Vault economy, PlaceholderAPI, MySQL, and metrics support.
Overview
VaultLeaderboards auto-detects supported plugins at startup. Vault is a hard dependency — the plugin will not start without it. PlaceholderAPI and MySQL are optional.
Vault Economy
Vault is a required dependency. VaultLeaderboards reads player balances via Economy.getBalance(player) and Economy.getBalance(OfflinePlayer).
This works with any Vault-compatible economy plugin — EssentialsX, CMI, AxMoney, McMMO, EconomyShopGUI, and more.
The plugin disables itself at startup if Vault or no economy provider is found.
PlaceholderAPI
When PlaceholderAPI is installed, VaultLeaderboards automatically registers its expansion. This exposes leaderboard data as placeholders that can be used in any PAPI-compatible plugin (scoreboards, TAB, chat formats, etc.).
Use %vaultleaderboards_<placeholder>% in any compatible plugin.
MySQL (Optional)
When database mode is enabled in config.yml, VaultLeaderboards syncs balances to a MySQL database via HikariCP for cross-server synchronized leaderboards.
Balance history is recorded automatically, enabling time-based "top earner" queries. Old history records older than 30 days are purged automatically.
Placeholders
Available placeholders when PlaceholderAPI is installed:
| Placeholder | Description |
|---|---|
| %vaultleaderboards_top_<rank>% | Top player at rank N (e.g. %vaultleaderboards_top_1%) |
| %vaultleaderboards_server_average% | Server-wide average balance |
| %vaultleaderboards_<playername>% | Specific player's rank and balance |
| %vaultleaderboards_topearner_<rank>_<days>d% | Top earner over last N days (database mode only) |
topearner placeholder only works when database mode is enabled. In local mode it returns an error message.
Metrics
VaultLeaderboards includes bStats and FastStats for anonymous usage statistics. This helps understand plugin adoption across servers.
Metrics can be disabled by setting bstats.enabled: false in config.yml.