Documentation
Economy and progressComplete

Leaderboards

Network wide rankings, all time or reset every day, week or month, with automatic rewards for the winners.

The Leaderboards module ranks your players by money, level, playtime, statistics and more. Rankings cover your whole network. A leaderboard can be permanent or run in seasons that reset every day, week or month, and the best players of each season can be rewarded automatically.

Note

This module requires the complete edition. See editions.

Features

  • Any number of leaderboards, each with its own name, icon, size and period.
  • Many ranking sources, picked from a list in the editor.
  • Seasons. A daily, weekly or monthly leaderboard ranks what players gained since the period started, then starts again from zero. Weekly periods start on Monday.
  • End of period rewards. Money and commands for chosen places. Players who are offline receive their reward when they next log in.
  • Winner announcement. When a period ends, the top 3 is announced in the chat on every server.
  • In game menu. /top opens a menu with every leaderboard, the top 3 of each and the player's own place. Clicking one shows the full ranking with player heads.
  • Everywhere else too. Leaderboards can be shown in your menus, in holograms, through placeholders and with the /leaderboard command of the Discord bot.

Ranking sources:

Group Source Needs
Economy Money (main currency), or money in any other currency Economy
Progression Level, XP, Achievements unlocked Progression
Statistics Lifetime count of any tracked activity: blocks broken, blocks placed, mobs defeated, players defeated, fish caught, items crafted, meals eaten, blocks walked, playtime, chat messages, animals bred, items enchanted, villager trades, daily rewards claimed Progression
Activity Active playtime (AFK time removed) Nothing
Activity Daily reward streak, Daily rewards claimed Rewards

If the module behind a source is turned off, the editor warns you and that leaderboard is skipped until you turn it back on.

Setting it up

Open the Leaderboards module in the web editor and go to the Editor tab. Each leaderboard is a card. Click Add a leaderboard to create one.

On each card:

  • Icon and ID. The ID is used in commands and placeholders: lowercase letters, digits and _, 32 characters at most, unique.
  • Name shown to players. Leave it empty to use the source name.
  • Ranked by: the source.
  • Period: All time, Daily, Weekly or Monthly.
  • Places: how many players the leaderboard shows, from 1 to 100.
  • Current ranking, with the time left before the next reset for seasonal leaderboards, and the Last winners.
  • End of period rewards (seasonal leaderboards): click Add a reward, choose a range of Places (for example 2 to 3), the money with its currency, and commands. Commands run from the console, one per line. {player}, {position} and {board} are replaced by the player name, their place and the leaderboard ID.
  • The placeholder for the first place, ready to copy.

The Refresh button recalculates every leaderboard right away.

Out of the box you get eight leaderboards: Richest players, Highest levels, Most active, Achievement hunters, XP of the week (weekly), PvP of the month (monthly), Best miners and Longest daily streak. XP of the week rewards its top 3 and PvP of the month its top 3.

In the Settings tab:

Setting What it does Default
Refresh every (seconds) How often rankings are recalculated, from 15 to 3600. 60
Time zone Used for daily, weekly and monthly resets, for example Europe/Paris. Empty uses the server time zone. Empty
Announce the winners When a period ends, the top 3 is announced in the chat of every server. On
Player heads in menus Shows player heads in the ranking menu. Off shows gold, iron and copper blocks for the top 3 and paper for the others. On

Commands

Command What it does Permission
/top (also /leaderboard, /leaderboards, /lb) Opens the leaderboards menu. From the console, lists the leaderboards. inglis.leaderboards.use (everyone)
/top <id> Opens one leaderboard. inglis.leaderboards.use (everyone)
/top <id> <page> Shows a leaderboard in the chat, 10 places per page, with your own place at the end. inglis.leaderboards.use (everyone)
/top refresh Recalculates every leaderboard now. inglis.leaderboards.admin (operators)

Placeholders

Replace <id> with the leaderboard ID and <n> with a place from 1 to 100.

Placeholder Shows
%ingliscore_top_<id>_<n>_name% Name of the player at that place
%ingliscore_top_<id>_<n>_value% Their value, formatted (money, time, level or number)
%ingliscore_top_<id>_<n>_uuid% Their UUID, handy to show their head
%ingliscore_top_<id>_rank% The viewing player's own place
%ingliscore_top_<id>_value% The viewing player's own value
%ingliscore_top_<id>_title% The leaderboard name

Example: %ingliscore_top_money_1_name% shows the richest player. A player who is not within the first 100 sees 100+ as their place.

See placeholders for how to use them.

Tips

  • Rewards only go to places the leaderboard shows: a leaderboard with 3 Places can only reward the top 3.
  • On a seasonal leaderboard ranked by Level, players are ranked by the XP they gained during the period, so the value shows XP instead of a level.
  • In the menus module, the Automatic content of a slot can show a leaderboard button or the player at a given place.
  • On a seasonal leaderboard, changing the source or the period starts a new ranking from zero, so values of different kinds are never mixed.