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

alias_command: TEXT

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

alias_suggestion: TEXT

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

type: TEXT

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

Score Prefix

score_prefix: TEXT

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

Score Suffix

score_suffix: TEXT

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

Include Zero

include_zero: BOOLEAN

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

Custom Items

custom_items:
  firstItem:
    material: MATERIAL
    # ...
  secondItem:
    material: MATERIAL
    # ...

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

Leaderboard Player Override

leaderboard_player:
  # ...

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

Leaderboard Item Override

leaderboard_item:
  # ...

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

Menu Title

menu_title: TEXT

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

Main Menu Visible

main_menu_visible: BOOLEAN

Define whether the board should be visible in the main menu