Install the plugin
Put AvenoxLeaderboard.jar into your server's plugins/ folder.
AvenoxLeaderboard
AvenoxLeaderboard is a clean, configurable leaderboard system for Paper and Folia servers with GUI leaderboards, PlaceholderAPI support, Vault economy support, sorting and persistent storage.
Follow these steps in order. The plugin is designed for modern Paper/Folia servers.
Put AvenoxLeaderboard.jar into your server's plugins/ folder.
Install PlaceholderAPI for placeholders. For Money, use Vault with an economy provider.
Restart instead of using a plugin reload. AvenoxLeaderboard creates its configuration files automatically.
Use /leaderboard or its aliases /lb and /top.
Only install what your server features actually use.
Required server platform. The current build targets the Paper API and declares Folia support.
Required for AvenoxLeaderboard's %ulb_... placeholders and custom placeholder-based boards.
The Money board reads an economy provider through Vault when available. PlaceholderAPI's Vault expansion is used as a fallback.
Supported for permission-based filtering and permission integration. It is a soft dependency.
Identifier: ulb. Replace <board> with a board ID and <position> with a rank number.
%ulb_kills_1_name% returns the username in position #1 of the Kills leaderboard.
| Placeholder | Returns | Example |
|---|---|---|
%ulb_<board>_<position>_name% | Username at a leaderboard position | %ulb_kills_1_name% |
%ulb_<board>_<position>_value% | Formatted value at that position | %ulb_money_1_value% |
%ulb_<board>_<position>_displayname% | Player display name | %ulb_kills_1_displayname% |
%ulb_<board>_<position>_position% | Position number | %ulb_kills_1_position% |
%ulb_<board>_position% | Viewer's current rank | %ulb_kills_position% |
%ulb_<board>_value% | Viewer's current formatted value | %ulb_kills_value% |
%ulb_<board>_size% | Total entries in the cached snapshot | %ulb_kills_size% |
%ulb_<board>_total% | Alias of size | %ulb_kills_total% |
#1 %ulb_kills_1_name% - %ulb_kills_1_value%
#2 %ulb_kills_2_name% - %ulb_kills_2_value%
#3 %ulb_kills_3_name% - %ulb_kills_3_value%
#4 %ulb_kills_4_name% - %ulb_kills_4_value%
#5 %ulb_kills_5_name% - %ulb_kills_5_value%
Place leaderboard values in scoreboards, holograms, TAB layouts, chat formats and other PlaceholderAPI-compatible plugins.
Use one of the built-in IDs such as kills, money or playtime.
Use 1 for first place, 2 for second place, and so on.
Use _name, _value, _displayname or _position.
Example:
Put these placeholders into any plugin that supports PlaceholderAPI.
#1 %ulb_money_1_name% — %ulb_money_1_value%
#2 %ulb_money_2_name% — %ulb_money_2_value%
#3 %ulb_money_3_name% — %ulb_money_3_value%
Use the command list below as a quick server-admin reference.
/leaderboardOpen the leaderboard GUI/lbAlias/topAlias/leaderboard open <id>Open a specific board/leaderboard listList configured boards/leaderboard info <id>Show board information/leaderboard position <id> [player]Show a player's position/leaderboard search <id> <player>Search leaderboard entries/statsOpen personal statistics/leaderboard reloadReload plugin configuration/leaderboard update <id>Force a board update/leaderboard reset <id>Reset a board/leaderboard resetallReset all boards/leaderboard set <id> <player> <value>Set an entry manually/leaderboard remove <id> <player>Remove an entry/leaderboard helpShow helpCore configuration files live in plugins/AvenoxLeaderboard/.
config.ymlPerformance, cache, tracking, ranking, number formatting and logging.
leaderboards.ymlBoard definitions, sources, statistics, update intervals and entry limits.
gui.ymlMain GUI, board-view GUI, stats GUI, item slots, lore and sounds.
messages.ymlPlugin messages and command responses.
storage.ymlSQLite/MySQL storage settings and connection options.
my-board:
display-name: "&bMy Board"
source: PLACEHOLDER
placeholder: "%some_placeholder%"
type: NUMBER
order: DESC
timed: ALL_TIME
update-interval: 30
max-entries: 100
enabled: true
These are the seven default boards in the current AvenoxLeaderboard configuration.
killsPLAYER_KILLS statistic
deathsDEATHS statistic
moneyVault economy balance
blocks-minedEvent counter
blocks-placedEvent counter
playtimePLAY_ONE_MINUTE ÷ 20
mob-killsEvent counter
Check these first when a board or placeholder is not showing the expected result.
Confirm PlaceholderAPI is installed, the ulb identifier is correct, and the board ID exists.
Check that Vault is installed and an economy provider is active on the server.
Check gui.yml and reload/restart the server after configuration changes.
Verify the relevant board is enabled and that the player is not excluded by a configured permission/filter.
Make sure PlaceholderAPI is installed and the AvenoxLeaderboard expansion is registered. The identifier is ulb. Also verify the board ID and position are valid.
Use Vault with an economy provider. The plugin can also fall back to PlaceholderAPI's %vault_eco_balance% when the Vault integration is available.
Yes. The engine supports PlaceholderAPI-based custom boards and custom providers. Define a board in leaderboards.yml and add a GUI button if you want it visible in the main menu.
Edit plugins/AvenoxLeaderboard/gui.yml. You can change titles, slots, materials, names, lore, navigation and sounds.