> For the complete documentation index, see [llms.txt](https://docs.aeonxd.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aeonxd.xyz/plugins/leaderboardmenus/configuration/boards.yml.md).

# boards.yml

Per-board options.

You can use some placeholders found in [Placeholders](/plugins/leaderboardmenus/placeholders.md#contextual-placeholders)

## **Syntax**

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

## Board Name

{% code fullWidth="false" %}

```yaml
boards:
  boardName:
    # ...
```

{% endcode %}

The board name as defined in AjLeaderboard/Topper.

## Board Display Name

{% code fullWidth="false" %}

```yaml
display_name: TEXT
```

{% endcode %}

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

## Alias Command

{% code fullWidth="false" %}

```yaml
alias_command: TEXT
```

{% endcode %}

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

{% code fullWidth="false" %}

```yaml
alias_suggestion: TEXT
```

{% endcode %}

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

{% code fullWidth="false" %}

```yaml
type: TEXT
```

{% endcode %}

The type of thing this leaderboard shows. For example the board **player\_level** type could be **Level** or **Player Level**.

## Score Prefix

{% code fullWidth="false" %}

```yaml
score_prefix: TEXT
```

{% endcode %}

The prefix for the score. For example in the board **statistic\_walk\_one\_cm** the score prefix could be "**Walked "**.

## Score Suffix

{% code fullWidth="false" %}

```yaml
score_suffix: TEXT
```

{% endcode %}

The suffix for the score. For example in the board **statistic\_walk\_one\_cm** the score suffix could be " **blocks"**.

## Include Zero

{% code fullWidth="false" %}

```yaml
include_zero: BOOLEAN
```

{% endcode %}

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

## Custom Items

{% code fullWidth="false" %}

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

{% endcode %}

Custom items for this board. See [menu.yml](/plugins/leaderboardmenus/configuration/menu.yml.md#items) on how to create items.

## Leaderboard Player Override

{% code fullWidth="false" %}

```yaml
leaderboard_player:
  # ...
```

{% endcode %}

Define how a leaderboard player item looks in the menu. See [menu.yml](/plugins/leaderboardmenus/configuration/menu.yml.md#items) on how to create items.

## Leaderboard Item Override

{% code fullWidth="false" %}

```yaml
leaderboard_item:
  # ...
```

{% endcode %}

Define how a leaderboard item looks in the menu. See [menu.yml](/plugins/leaderboardmenus/configuration/menu.yml.md#items) on how to create items.

## Menu Title

{% code fullWidth="false" %}

```yaml
menu_title: TEXT
```

{% endcode %}

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

## Main Menu Visible

{% code fullWidth="false" %}

```yaml
main_menu_visible: BOOLEAN
```

{% endcode %}

Define whether the board should be visible in the main menu