TDXPlugins
TDX LeaderboardsGuides

Add a custom board

Define a new leaderboard, give it custom rewards, and verify it shows up in the GUI.

In this guide you'll add a "Top Fishers" board that tracks how many fish each player has caught this month, give the top three a custom reward, and check that it shows up in the in-game GUI.

Pick a tracking mode and a statistic

Fish caught this month is a period-based count, so we want type: DELTA. The Bukkit statistic is FISH_CAUGHT. No statistic-target needed — it's a top-level statistic, not a per-material one.

Add the board to config.yml

Open plugins/TDXLeaderboards/config.yml and add an entry under boards:. Pick an unused slot and an icon you like.

plugins/TDXLeaderboards/config.yml
boards:
  top_fishers:
    enabled: true
    title: "Top Fishers"
    description: "Most fish caught this month"
    type: DELTA
    statistic: FISH_CAUGHT
    material: FISHING_ROD
    slot: 19
    category: gathering
    glow-when-first: true

Add a per-board reward

In the same file, drop a per-board block under rewards: so the top three fishers get something nice when the month rolls over:

plugins/TDXLeaderboards/config.yml
rewards:
  per-board:
    top_fishers:
      1:
        commands:
          - "give %player% trident 1"
          - "eco give %player% 5000"
        message: "<#4DA6E8>Top Fisher of the month! +Trident, +$5k</>"
      2:
        commands:
          - "give %player% heart_of_the_sea 1"
        message: "<#A8D8F0>2nd place fisher! +Heart of the Sea</>"
      3:
        commands:
          - "give %player% nautilus_shell 3"
        message: "<#A8D8F0>3rd place fisher! +3 Nautilus Shells</>"

Reload and refresh

/lbadmin reload
/lbadmin update

reload re-reads config.yml, update forces an immediate refresh instead of waiting for the next update-interval tick.

Verify in-game

Run /leaderboard. The board should appear in slot 19 with a fishing rod icon, sitting in the Gathering category. Cast a few times — your own row will increment on the next refresh.

If the board doesn't show up, check latest.log for a [TDXLeaderboards] warning. The most common cause is a typo in the statistic name — Bukkit statistic constants are case-sensitive.

What to try next

  • Promote it to a glow board for the month's #1 by setting glow-when-first: true (already on in our example)
  • Tie a milestone to it so anyone who breaks into the top 10 gets a one-time pat on the back
  • Hook up a DecentHolograms display at spawn so non-GUI players can still see it