Leaderboards

🏆 Leaderboards

Leaderboards display top player rankings for various stats, encouraging competition and engagement. You can create, place, and customize as many leaderboards as you need.


🛠️ Creation

Creating a leaderboard is a two-step process: first, you define its properties in the configuration file, and second, you set its location in the game world.

1️⃣ Define in Config

All leaderboards are managed in your config file. You can add a new entry to define the number of players to show, the statistic it should track, and the game mode.

2️⃣ Add Location

Once you've configured a leaderboard, you need to place it in the world.

  1. Stand where you want the leaderboard to appear and look in the desired direction.

  2. Type the command /al copylocation.

  3. This copies a location string to your chat. Click the message to copy it.

  4. Paste this string into the location list for your leaderboard in the config file.

You can add multiple location strings to display the same leaderboard in several places at once.


⚙️ Parameters

Each leaderboard is a separate entry under the leaderboard: section in your configuration.

Parameter

Description

positions

The number of top players to display on the leaderboard.

statistic

The stat to track. Options: KILLS, WINS

mode

The game mode to track stats from.

Options: SOLO, TEAMS, GLOBAL

location

A list of in-game locations where the leaderboard will be displayed.

display

A list of text lines to format the leaderboard's appearance, using placeholders like {PLAYER_1} and {VALUE_1}.


💡 Example

  • Use placeholders like {PLAYER_1}, {PLAYER_2}, etc., to show player names at each rank.

  • Use {VALUE_1}, {VALUE_2}, etc., to show the corresponding stat value for each player.

  • You can use standard color codes (&b, &f, etc.) to style the display text.

Last updated