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: defining it in the config and placing it in the world.

1️⃣ Define in Config

All leaderboards are managed in leaderboards.yml. Add a new entry to define the number of players, the statistic, and the game mode.

2️⃣ Add Location

Once configured, place it in the world:

1. Stand where you want the leaderboard to appear.

2. Look in the desired direction.

3. Type /al COPYLOC.

4. Copy the location string from chat.

5. Paste it into the location list in leaderboards.yml.

---

⚙️ Parameters

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

Parameter	Type	Description
positions	integer	Number of players to display.
statistic	string	The stat to track (e.g., KILLS, WINS).
mode	string	Game mode: SOLO, TEAMS, or GLOBAL.
location	list	List of location strings where this leaderboard appears.
display	list	Text lines for the leaderboard. Supports placeholders.

---

💡 Example

From leaderboards.yml:

leaderboard:
  solo_kills:
    setting:
      positions: 10
      statistic: KILLS
      mode: SOLO
    location:
      - "world{world} x{-6.5} y{150.0} z{26.5} yaw{180.0} pitch{0.0}"
    display:
      - "&b&l&nTop Kills"
      - "&a👤 Solo"
      - ""
      - "&e#1 &f{PLAYER_1} &6{VALUE_1}"
      - "&e#2 &f{PLAYER_2} &6{VALUE_2}"
      - "&e#3 &f{PLAYER_3} &6{VALUE_3}"
      - "&e#4 &f{PLAYER_4} &6{VALUE_4}"
      - "&e#5 &f{PLAYER_5} &6{VALUE_5}"
      - "&e#6 &f{PLAYER_6} &6{VALUE_6}"
      - "&e#7 &f{PLAYER_7} &6{VALUE_7}"
      - "&e#8 &f{PLAYER_8} &6{VALUE_8}"
      - "&e#9 &f{PLAYER_9} &6{VALUE_9}"
      - "&e#10 &f{PLAYER_10} &6{VALUE_10}"
      - ""
      - "&7Refreshes every 30 min."

• Placeholders: Use {PLAYER_1} to {PLAYER_10} and {VALUE_1} to {VALUE_10}.

• Multiple Locations: You can list multiple location strings to show the same leaderboard in different spots.

• Styling: Standard color codes (&b, &f, etc.) are fully supported.