Skip to main content
The Open GUI Action opens a customizable inventory interface for the player.

​
Configuration

​
guiType
GuiType
default:"CUSTOM"
Type of GUI to display (CUSTOM, FURNACE, BEACON, etc.).
​
title
String
required
Title displayed at the top of the GUI. Supports placeholders.
​
size
InventorySize
default:"GENERIC_9X3"
Size of the inventory (only for CUSTOM type).
  • GENERIC_9X1 to GENERIC_9X6
​
items
List<GuiItemData>
List of items to populate the inventory.
​
additionalPages
List<List<GuiItemData>>
Define extra pages of items. Automatically adds navigation buttons.
​
nextPageItem
GuiItemData
Custom item to use for the “Next Page” button.
​
previousPageItem
GuiItemData
Custom item to use for the “Previous Page” button.

​
Item Configuration

Each item in the items list supports:
​
slot
Int
Specific slot index (0-53).
​
item
Item
The item to display (Material, Model Data, etc.).
​
displayName
String
Override display name. Using placeholders updates the name dynamically.
​
lore
List<String>
Custom lore lines.
​
criteria
List<Criteria>
Conditions required for this item to appear.
​
triggers
List<Ref<TriggerableEntry>>
Actions to execute when clicked.
​
commands
List<String>
Console/Player commands to execute on click.
​
allowPickup
Boolean
default:"false"
If true, player can move the item to their inventory.
action:
  type: open_gui
  title: "Server Menu"
  guiType: CUSTOM
  size: GENERIC_9X3
  items:
    - slot: 13
      item: COMPASS
      displayName: "<green>Teleporter"
      triggers:
        - "open_warp_menu"