boards.yml

Per-board options.

You can use some placeholders found in Contextual Placeholders

Syntax

boards:
  boardName:
    display_name: "TEXT"
    # more options...

Board Name

boards:
  boardName:
    # ...

The board name as defined in AjLeaderboard/Topper.

Board Display Name

display_name: TEXT

The display name used for the board. Must be raw text (without formatting).

Alias Command

The command alias name to directly open the menu. For example for the board vault_eco_balance, you could set the alias as /topbalance.

Alias Suggestion

The suggestion alias is to make the board name easier to read when typing the command. For example for the board vault_eco_balance, you could set the alias as balance. This way your players can use /lbm balance instead of /lbm vault_eco_balance

Type

The type of thing this leaderboard shows. For example the board player_level type could be Level or Player Level.

Score Prefix

The prefix for the score. For example in the board statistic_walk_one_cm the score prefix could be "Walked ".

Score Suffix

The suffix for the score. For example in the board statistic_walk_one_cm the score suffix could be " blocks".

Include Zero

Whether to include score of 0. Enabling this option shows all players that have the score 0.

Custom Items

Custom items for this board. See Items on how to create items.

Leaderboard Player Override

Define how a leaderboard player item looks in the menu. See Items on how to create items.

Leaderboard Item Override

Define how a leaderboard item looks in the menu. See Items on how to create items.

The menu title to override. Format: https://docs.advntr.dev/minimessage/format.html

Define whether the board should be visible in the main menu

Last updated