Menu Configuration

Complete reference for menu YAML configuration structure and properties.

---

File Location

All menus are YAML files located in:

/plugins/PhantomDungeons/menus/

Each file represents a complete menu. The filename (without .yml) becomes the menu ID.

Example:

• shop.yml → Menu ID: shop

• sword-upgrade.yml → Menu ID: sword-upgrade

• confirmation.yml → Menu ID: confirmation

---

Basic Structure

example-menu.yml

inventory:
  # Required Properties
  title: '&8My Custom Menu'
  slots: 54
  
  # Optional Properties
  on-open:
    - '[sound] ENTITY_EXPERIENCE_ORB_PICKUP 1.0 1.0'
  
  on-close:
    - '[sound] BLOCK_CHEST_CLOSE 1.0 1.0'
  
  variables:
    selected_tier: '1'
    current_page: '1'
  
  parent-menu: 'main-menu'
  update-interval: 20
  
  # Optional: Background decoration
  fillers:
    glass-border:
      slots: [0, 1, 7, 8, 36, 37, 43, 44]
      material: 'BLACK_STAINED_GLASS_PANE'
      name: ' '
  
  # Required: Interactive items
  menu-items:
    'item-id':
      slot: '10'
      material: 'DIAMOND'
      name: '&b&lExample Item'
      lore:
        - '&7Click to do something!'
      any-click-actions:
        - '[message] &aYou clicked!'

---

Configuration Properties

Inventory Section

Property	Required	Type	Description
title	Yes	String	The inventory title displayed to players
slots	Yes	Integer	Inventory size (9, 18, 27, 36, 45, or 54)
on-open	No	List	Actions executed when the menu opens
on-close	No	List	Actions executed when the menu closes
variables	No	Map	Default variable values for this menu
parent-menu	No	String	ID of the parent menu (for back buttons)
update-interval	No	Integer	How often to refresh the menu (in ticks, 20 = 1 second)
fillers	No	Map	Background decoration items
menu-items	Yes	Map	The interactive items in the menu

---

Title Configuration

The title supports variables and PlaceholderAPI:

Simple

title: '&8My Shop'

With Variables

With Placeholders

Combined

Titles are processed in order: Variables → PlaceholderAPI → Color codes

---

On-Open / On-Close Actions

Execute actions when the menu opens or closes:

On-Open

on-open:
  - '[sound] BLOCK_CHEST_OPEN 1.0 1.0'
  - '[message] &eWelcome to the shop!'

On-Close

Complex

---

Variables Configuration

Define default values for menu variables.

We are also actively developing some new functionalities, such as dynamic placeholder api parsing, and time-based variables.

Simple

variables:
  page: '1'
  category: 'all'

Complex

Variables are always strings. Numbers should be in quotes: page: '1' not page: 1

---

Parent Menu

Enables back-navigation support:

# In child-menu.yml
parent-menu: 'main-menu'

# Then in items, use:
menu-items:
  'back-button':
    any-click-actions:
      - '[menu] {parent-menu}'  # Returns to main-menu

---

Update Interval

Auto-refresh the menu at regular intervals:

Disabled (Default)

# No update-interval specified
# Menu never auto-refreshes

Every Second

Every 5 Seconds

Use Cases:

• Live stat displays

• Real-time leaderboards

• Countdown timers

• Balance tracking

Frequent updates can be performance-intensive. Use sparingly!

---

Fillers Configuration

Background decoration items for better UX:

Simple Border

fillers:
  border:
    slots: [0, 1, 7, 8, 45, 46, 52, 53]
    material: 'BLACK_STAINED_GLASS_PANE'
    name: ' '

Full Background

Multiple Fillers

---

Menu Items Configuration

The core interactive elements of your menu:

Complete Item Example

menu-items:
  'item-id':
    # Required
    slot: '13'
    material: 'DIAMOND'
    
    # Display
    name: '&b&lDiamond Item'
    lore:
      - '&7This is line 1'
      - '&7This is line 2'
    
    # Optional Properties
    amount: 1
    glow: 'false'
    custom-model-data: '1001'
    item-flags: ['HIDE_ATTRIBUTES', 'HIDE_ENCHANTS']
    
    # Conditions
    view-requirement: '%phantomdungeons_sword_tier% >= 3'
    click-requirement: '%vault_eco_balance% >= 1000'
    
    # Actions
    any-click-actions:
      - '[sound] UI_BUTTON_CLICK 1.0 1.0'
      - '[message] &aClicked!'
    
    left-click-actions:
      - '[message] &7Left clicked'
    
    right-click-actions:
      - '[message] &7Right clicked'
    
    shift-click-actions:
      - '[message] &7Shift clicked'

Item Properties

Property	Required	Description
slot	Yes	Inventory slot number (0-53)
material	Yes	Item material (or texture-base64/skull-url)
name	No	Display name (supports colors & placeholders)
lore	No	Item lore lines (list)
amount	No	Stack size (1-64, default: 1)
glow	No	Make item glow (true/false)
custom-model-data	No	Custom model data ID
item-flags	No	Item flags to hide elements
view-requirement	No	Condition to show the item
click-requirement	No	Condition to allow clicking
any-click-actions	No	Actions on any click type
left-click-actions	No	Actions on left click only
right-click-actions	No	Actions on right click only
shift-click-actions	No	Actions on shift click only

---

Slot Notation

Multiple ways to specify slots:

Single Slot

slot: '13'  # Center of 27-slot menu

Array

Range

Mixed

---

Material Types

Standard Materials

material: 'DIAMOND'
material: 'EMERALD'
material: 'PLAYER_HEAD'

Bukkit Material Reference

Custom Player Heads

Base64 Texture

material: 'texture-eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZjJmM2EyZGZjZTBjM2RhYjdlZTEwZGIzODVlNTIyOWYxYTI2M2Y1YzY5NmI3MWM1OTQ1NzYxZDI3NzFmOGEzMiJ9fX0='

Skull URL

---

Item Flags

Hide item metadata:

item-flags:
  - 'HIDE_ATTRIBUTES'
  - 'HIDE_ENCHANTS'
  - 'HIDE_UNBREAKABLE'
  - 'HIDE_DESTROYS'
  - 'HIDE_PLACED_ON'
  - 'HIDE_POTION_EFFECTS'
  - 'HIDE_DYE'

---