Leaderboards

Rank players by lifetime currency, blocks, and quests, in the menu and with /et top.

The plugin ranks players by their lifetime totals. Three things are tracked:

Currency earned
Blocks mined
Quests completed

A board can be read in two scopes. Server-wide adds up every tool a player owns. Per tool counts one tool type only. The command is always server-wide. The in-menu board follows leaderboard.menu-scope, shown below.

Viewing the leaderboard

There are two ways to see the rankings.

Open a tool's menu and click Leaderboards. Each row shows a rank, a player head, the player name, and the value. Three buttons at the top switch between Currency, Blocks, and Quests. The button for the list you are viewing is highlighted.

What the menu board counts depends on leaderboard.menu-scope:

tool (default): ranks only the tool you opened the menu from, using that tool's totals.
global: ranks server-wide totals across every tool.
both: adds a View toggle inside the board to switch between this tool and server-wide.

Run /et top for the currency board, or name a metric:

/et top
/et top blocks
/et top quests

If a board has more rows than fit on one page, add a page number:

/et top currency 2

Opting out

When leaderboard.allow-opt-out is on, a player can remove themselves from every board:

/et top hide
/et top show

A hidden player keeps earning and keeps their totals. They just do not show in any ranking until they run /et top show. If you turn the feature off, /et top hide tells the player it is disabled.

Turning leaderboards off

Set leaderboard.enabled to false. This removes the Leaderboards button from the menu, disables /et top, and stops the leaderboard placeholders.

Renaming the boards

The metric names (Currency, Blocks, Quests) and the board titles come from the language file, not from code. So they translate with the active language and you can rename them. Edit the metric-currency, metric-blocks, and metric-quests lines, and the menu.leaderboard.title-tool and title-global lines, in lang/<code>.yml. See Languages.

How rankings update

Rankings are rebuilt from the database on an interval and kept in memory. So opening the menu or running the command never queries the database on the main thread, and never causes a lag spike. The default interval is five minutes. Lower it for fresher numbers, or raise it to do less work.

These keys live under leaderboard in config.yml:

Prop

Type

The same cached rankings power the %zet_top_...% and %zet_rank_...% placeholders. See Placeholders.