boards

The boards block is the heart of the plugin. Every leaderboard you see in the GUI is one entry in this block. This is the page to read if you only read one configuration page.

Quick example

This is the bundled playtime board, exactly as it ships:

boards:
  playtime:
    enabled: true
    display-name: "<#F0B060><bold>Playtime</bold>"
    description: "Most hours logged this month"
    material: CLOCK
    type: STATISTIC
    statistic: PLAY_ONE_MINUTE
    tracking: DELTA
    value-format: "TIME"
    gui-slot: 12
    category: social

Add a board like that, run /lbadmin reload, and it shows up in the GUI. The key you give it (playtime here) is the board id. You use that id in commands, placeholders and the per-board rewards block.

Two settings decide what a board tracks

type says where the number comes from. tracking says how progress is measured over a period. They are separate settings, and a board needs both.

Board types

CUSTOM_DAMAGE_DEALT and CUSTOM_QUESTS arrived in v1.9.16. CUSTOM_BLOCKS_BROKEN, CUSTOM_WOOD, CUSTOM_POTIONS_BREWED, CUSTOM_TAMED and CUSTOM_COUNTER arrived in v1.9.17.

Tracking modes

Reference

Feeding a board from another plugin

A CUSTOM_COUNTER board never moves on its own. It counts whatever you tell it to, through one command:

/lbadmin addstat <player> <board-id> <amount>

Put that in another plugin's reward commands and that plugin now feeds a leaderboard. An event plugin can credit a win like this:

boards:
  events-won:
    enabled: true
    display-name: "<#FFD93D><bold>Events Won</bold>"
    description: "Most events won this month"
    material: NETHER_STAR
    type: CUSTOM_COUNTER
    tracking: ACCUMULATE
    value-format: "%value% wins"
    gui-slot: 40
    category: misc

lbadmin addstat {player} events-won 1

addstat works on any board the plugin counts itself, so every ACCUMULATE board, not only CUSTOM_COUNTER. It refuses a board that reads a live value. It needs the tdxleaderboards.admin.setstat permission, the same one as setstat.

The amount shows on the board at the next refresh. The player can be offline as long as they have joined before: the amount is saved straight away, but a board only recalculates players who are online, so theirs appears the next time they are on the server for a refresh.

Hidden boards

Set hidden: true on a board that should only feed placeholders, for example a hologram at spawn. A hidden board has no tile in the GUI, gives no points or rewards, and is never announced.

boards:
  holo-balance:
    enabled: true
    hidden: true
    display-name: "Richest"
    type: VAULT_BALANCE
    tracking: CURRENT
    value-format: "$%value%"

Read it with %tdxleaderboards_board_<id>_name_<1-10>% and %tdxleaderboards_board_<id>_value_<1-10>%. With tracking: CURRENT it shows the live value of everybody who has logged in since the last reset, so inactive players fall off on their own.

Settings for the plugin-counted types

These live in the custom-tracking block, outside boards.

Damage is counted on the same scale as the vanilla statistic, 10 per heart, and only for health actually taken off the target. Overkill does not count.

Rewards for one board

Points rewards pay out from the overall points leaderboard. To also reward the top players of a single board, add it under rewards.board-rewards using the board id:

rewards:
  board-rewards:
    ores-mined:
      1:
        commands:
          - "give %player% diamond_pickaxe 1"
        message: "<#4DA6E8>Top miner! Enjoy a diamond pickaxe."
      2:
        commands:
          - "give %player% diamond 3"
        message: "<#4DA6E8>2nd place miner! Here's 3 diamonds."

A winner who is offline when the period resets gets their commands the next time they join.

See also

• Commands for /lbadmin addstat and setstat
• Placeholders for the full placeholder list
• Add a custom board