🎑Customize Menus

On this page, you will find information on how to customize the crate 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 milestones menu - CRATE_MILESTONES

• The reroll menu - CRATE_REROLL

• The rewards preview menu - REWARDS_PREVIEW

• The select reward menu - SELECT_REWARD

Menus Folder

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: # CRATE_MILESTONES, CRATE_REROLL, REWARDS_PREVIEW, SELECT_REWARD
  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.

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]'

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)'

Milestone

Milestone is the item you can use to redirect users from the rewards preview menu to the milestones menu, allowing them to see their progress with the milestones.

milestone:
  slot: '4'
  material: NETHER_STAR
  amount: 1
  custom-model-data: 0
  glow: true
  hide-attributes: true
  display-name: '&a%milestone_type% Milestones'
  lore:
  - '&7By clicking here you will be able to'
  - '&7access the milestones of this crate.'
  - ''
  - '&6Left-Click: &eNavigate.'
  menu: default_crate_milestones

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.