🎑 Customize Menus

#Crate Menus

All the crate menus you can customize for the plugin are located in the menus folder of Phoenix Crates. These menus are:

• The rewards preview menu - REWARDS_PREVIEW
• The select reward menu - SELECT_REWARD
• The confirmation menu - CONFIRMATION
• The reroll menu - CRATE_REROLL
• The virtual keys menu - VIRTUAL_KEYS

Add-ons register menus of their own, which only exist once the add-on is installed:

• The mass opening menu - CRATE_MASS_OPENING
• The mass reroll menu - CRATE_MASS_REROLL
• The mass selection menu - CRATE_MASS_SELECTIVE
• The claim menu - CRATE_CLAIM

If you want to have a different preview menu for a crate, you can simply create your own custom menu and attach it to the crate's Preview Menu instead of changing the default one.

#Menu Settings

Menu settings can be found in any type of menu. From there, you can specify the type of menu you want, the title of the menu, the number of rows it will have, the refresh rate, and the actions that will run when the user clicks to preview it.

settings:
  type: # REWARDS_PREVIEW, SELECT_REWARD, CONFIRMATION, CRATE_REROLL, VIRTUAL_KEYS
  title: '%crate% Rewards'
  rows: # 1, 2, 3, 4, 5, 6
  refresh:
    enabled: false
    rate: 20
  on-open-actions: []

You can change the rows number if you want to adjust the rows that the menu will have.

#Confirmation Menu

The confirmation menu is shown to players before an action is carried out, such as opening a crate with an Open Money Cost or picking a reward in Selective mode. It has its own confirm and cancel items alongside the usual item-slot, which shows the item the player is about to receive/select. This menu can be skipped entirely with the Disable Confirmation Menus option, found in the editor's Settings menu.

#Pagination

Pagination is another main option that menus have. With this, you can create multiple pages, set your preview page item, the next page item, and a material that will fill specific slots.

#Items

With the items, you can create custom entries to be included in your menu. These could be items to close the menu or items that display where players can purchase keys.

items:
  close-menu:
    slot: '49'
    material: ARROW
    amount: 1
    custom-model-data: 0
    glow: false
    hide-attributes: false
    display-name: '&aClose Menu'
    lore:
    - '&7Click here to close this menu.'
    - ''
    - '&6Left-Click: &eClose menu.'
    actions:
    - '[CLOSE_INVENTORY]'

Two more options are available on any item and are not in the example above:

• item-model - The item model identifier to use, on server versions that support it.
• hide-tooltip - Hides the item's tooltip completely. This is what the filler panes in the default menus use.

The slot accepts a single slot ('49'), a range ('45-53'), or a comma separated mix of both ('0, 8, 45-53'), so one entry can fill several slots at once.

#Item Material

Every item in a menu takes a material, the pagination arrows, the decorative fillers and the available keys item included. Alongside vanilla materials it accepts the same hooked values as a reward, so any of them can be a custom item from ItemsAdder, Nexo, CraftEngine, MMOItems, ExecutableItems, Mythic Items or HeadDatabase.

pagination:
  next-item:
    slot: '26'
    material: itemsadder:medieval_crates:next_arrow
    custom-model-data: 0
    item-model: ''
    display-name: '&6Next page - Page %page%'

Keep custom-model-data at 0 and item-model empty on a hooked material. Both are applied on top of whatever the hook returns and would override the model the custom item already carries. A 0 and an empty value are skipped, leaving the hook's own model alone.

An item rendering as a barrier means the material was accepted as a hooked value but nothing came back, either because the id is wrong or because the hooking plugin had not finished loading its items when the menu was built. A material rejected outright is logged as an unknown material on startup instead.

#Reward

The rewards are the items you offer in your crate. You can adjust their names, lore, and configure them as you wish. The selective reward option also includes a setting for a locked item, in case the reward has already been claimed. The reward slots will be based on the slots: that were set in the pagination

reward:
  name: '&7%reward_name%'
  lore:
  - '%reward_lore%'
  - ''
  - '&eYour percentage: &6%percentage%%'
  - '&eYour chance: &6%chance%%'
  - ''
  - '&7Check our &6&lWIKI &7to understand the difference'
  - '&7between percentage and chance.'
  - ''
  - '&7(This lore is configured at the menus folder)'

#Review & Reroll

These two items are found in the reroll menu. The review option allows you to claim the reward you won, while the reroll option lets you get another reward instead.

#Virtual Keys Menu

The menu behind /crates virtualKeys lives in menus/virtual_keys.yml and is customized like any other, with its own settings, pagination and items. On top of those it has a key-item block, which is the entry rendered for each of the player's keys.

key-item:
  display-name: '&e%key_name%'
  lore:
  - '%item_lore%'
  - ''
  - '&fAmount: &e%amount%'

Placeholder	Description
%key_name%	The key's display name.
%amount%	How many of that key the player has.
%item_lore%	The lore of the key item itself.

The item's material comes from the key, so it always looks like the real key.