Placeholders
All PlaceholderAPI placeholders for top players, server stats, and time-based queries.
Overview
VaultLeaderboards registers the vaultleaderboards expansion when PlaceholderAPI is installed.
Use these placeholders in any PAPI-compatible plugin: scoreboards, TAB, chat formats, signs, etc.
Top Placeholders
Display top players from the leaderboard:
| Placeholder | Description | Example |
|---|---|---|
| %vaultleaderboards_top_1% | Player at rank 1 | 1. Steve - $50000.00 |
| %vaultleaderboards_top_5% | Player at rank 5 | 5. Alex - $12000.00 |
| %vaultleaderboards_top_10% | Player at rank 10 | 10. Notch - $5000.00 |
Replace
1, 5, 10 with any rank number up to the configured top-limit (default 10).
Player Placeholders
Query a specific player's rank and balance:
| Placeholder | Description | Example |
|---|---|---|
| %vaultleaderboards_Steve% | Steve's rank and balance | Steve is #3 with $50000.00 |
| %vaultleaderboards_Alex% | Alex's rank and balance | Alex is #7 with $8500.00 |
Player names. The placeholder argument must be a valid Minecraft username (3-16 alphanumeric/underscore characters). The name is case-sensitive.
Server Placeholders
Server-wide economy statistics:
| Placeholder | Description | Example |
|---|---|---|
| %vaultleaderboards_server_average% | Average balance across all tracked players | Server Average: $12345.67 |
Time-Based Placeholders
Top earners over a configurable time period (database mode only):
| Placeholder | Description | Example |
|---|---|---|
| %vaultleaderboards_topearner_1_7d% | Top earner over last 7 days | 1. Steve +$5000.00 (7d) |
| %vaultleaderboards_topearner_3_30d% | 3rd top earner over last 30 days | 3. Alex +$2000.00 (30d) |
Database mode required. The
topearner placeholders only work when database mode is enabled in config.yml. In local mode, they return an error message.