Skip to content

Create menu.

broken1arrow edited this page Apr 11, 2026 · 11 revisions

Setup for ether have all menus in single file or one menu in every file.

Menus:
  # Menu name, need to be unique.
  Main_Menu:
    # menu size
    Menu_Size: 36
    # menu title
    Menu_Title: "&1Main menu"
    # slots you want to use to add fill items inside, the usage pattern depending on the plugin usage.
    FillSpace: 9-35
    #This three options below depends on how the plugin implement this options.
    #If i shall update all buttons when one is clicked.
    Refresh_all_buttons: false
    # if it shall update buttons when menu open (my menu API have this support).
    Shall_update_on_interval: true
    #time format depends on the plugin
    Update_all_buttons_interval: -1
    # menu key for all items in the menu (don´t change this name).
    Open_requirement:
      Requirement:
    Menu_Items:
      # button/item name, need to be unique.
      menu_button_1: 
        # the item type you can also use placeholders.
        Icon: STONE
        Slot: 1

Setup for one menu option 1.

If you set up one menu in the file.

Menus:
  # menu size
  Menu_Size: 36
  # menu title
  Menu_Title: "&1Main menu"
  # slots you want to use to add items inside (used intern in the plugin).
  FillSpace: 9-35
  #This two options below depends on how the plugin implement this options.
  #If i shall update all buttons when one is clicked.
  Refresh_all_buttons: false
  # Time when shall update the buttons.
  Update_all_buttons_interval: 5
  Open_requirement:
    Requirement: 
  Menu_Items:
    # button/item name, need to be unique. 
    menu_button_1: 
      # the item type you can also use placeholders.
      Icon: STONE
      Slot: 1   

Setup for one menu option 2.

If you set up one menu in the file.

Menus:
  # menu size
  Menu_Size: 36
  # menu title
  Menu_Title: "&1Main menu"
  # slots you want to use to add items inside (used intern in the plugin).
  FillSpace: 9-35
  #This two options below depends on how the plugin implement this options.
  #If i shall update all buttons when one is clicked.
  Refresh_all_buttons: false
  #time format depends on the plugin 
  Update_all_buttons_interval: -1
  Open_requirement:
    Requirement:  
Menu_Items:
  # button/item name, need to be unique. 
  menu_button_1: 
    # the item type you can also use placeholders.
    Icon: STONE
    Slot: 1   

Menu Size

Size of the inventory.

Menu_Size: 54

Menu Title

Size of the inventory. Translations of colors depend on implementation of this api.

Menu_Title: "title"

Sound

Set sound when open inventory (depend on implementation of this api). look here for all sound types

Sound: BLOCK_NOTE_BLOCK_BASEDRUM

Menu type

Type of inventory. If not set it will be chest. Look here for all types.

Menu_Type: chest

Open requirement

Requirement player need to open menu. check requirements here.

Open_requirement:
  Requirement:
    # you can set several requirements but every one
    # need to be unique named.
    require_name:
      # check Requirements tab.
  # stop on first requirement some return true.
  stop_at_success: true
  # number of requirement some need return true.
  # only works if optional_requirement is set to true.
  minimum_requirement: 1
  # only works with click requirement and open.
  deny_commands:
    - "[ACTION] your command or message here" 

Depend on implementation of this api

Fill space

Depending if this will be used or not. you can use it for tell buttons some shall be filled auto (inside your plugin if you want to parse a list of something (material,spawn egg or other things)) or to allow some slots for add/remove items.

FillSpace: 9-35

Update button

If you want a button be updated on interval while menu is open.

Update_interval: 5
#Optional depending how the plugin implement the on and off function.
#Update_on_interval: true

Global for all buttons intervals

Time between every update in seconds set for all buttons.

Update_all_buttons_interval: 5
#Optional depending how the plugin implement the on and off function.
#Shall_update_on_interval:true

Clone this wiki locally