Level menu

menus/levels.yml configuration guide

title - Title of the inventory

level-track - Defines how many levels are shown and where to put them. The first is always the current, 2nd is always the in-progress level. After that, everything will be the next not yet completed levels. In case if you you use the paginted menu variant, the positions of the menu items mentioned before will be automatically computed on the page.

use-pagination- Setting this to true will create a menu that has pages. Only works if there is a max-level set in config.yml

use-item-amounts - Setting this to true will set the item amounts on the menu items equal to the level the menu item represents. Only works if you have a max-level set in config.yml that is less or equal to 64.

progress-bar:

• length - how many characters should a progress bar use?

• filled-character - character to show for the progress bar completed part

• unfilled-character - character to show for the progress bar not completed part

Display components

These are for more advanced templating features. Currently, only rewards are supported as components.

display-components:
  rewards:
    title: "&7ʀᴇᴡᴀʀᴅѕ"
    line: "  {reward}"

The title will only show at the start when there is at least one reward. The line will be filled with the reward placeholder, and every reward will get its new line.

Items

Filler

Set enabled to false if you don't want any inventory filler item. You can use every item option under the item field.

Completed/next/locked level

This will be shown when the level is completed/locked/in progress by the player in the menu. You can use every item option for these. For custom levels, you can override parts of the item or even the whole item in your main config. For example for a high reward level, you could change the menu item material to stand out.

Previous/current/next page

These are pagination controls in the menu. They will only be visible if pagination is necessary. Every item option can be used here.

Custom items

You can add extra items with click actions to the menu. Every item option can be used. on-left-click, on-right-click and on-click are also supported. These are a list of commands backed by CommandDispatcher. You can read about what can it do in Rewards.

Leaderboards

If you want to display leaderboards, you can use some internal placeholders. Add this to your custom items:

  info:
    name: "&aYour level ranking"
    material: painting
    slot: 4
    lore:
      - "&8Global ranking"
      - ""
      - "&7Your level: &f{level}"
      - "&7Total XP: &f{current_short}"
      - ""
      - "&7Rank: &8#&a{lb_position}"
      - "&8You are in the top &a{lb_position_percent}%&8 of &7{lb_size}"
      - "&8players!"