Menu Configuration

Here you can view all the configuration, examples and options for creating menus in Player Warps.

Menu Creation

In Player Warps you customize the menus that are provided by the plugin, please note that you cannot create new menus that aren't already provided by the plugin. You can change how the menu is displayed and how it works.

Please note all the menu tags show here aren't ALL the tags, but the basic & default tags for all menus. Some menus may add more tags, these are added to the config by default.

Menu Size

When creating a menu, you need to specify the size of the menu. You need to specify multiples of 9 only as each of a chest is 9 slots. The maximum of slots you can have is 54 (9*6) 6 being the max of rows.

Here is an example on how to use the menu size, below in the example the size of the menu contains 27 slots and will be 3 rows.

Configuration Example

menu: # The menu name goes here, you cannot change this.
  size: 27 # The size of the menu, must be a multiple of 9.

Menu Title

When creating a menu, you need to specify the title of the menu. You may use color codes in your title. You cannot have multiple lines in a title, this is a limitation of Minecraft.

Please note server version 1.17.10 does limit titles to be 32 characters including color codes.

Here is an example on how to use the menu title, below in the example the title of the menu will be "My lovely menu" in aqua.

Configuration Example

menu: # The menu name goes here, you cannot change this.
  size: 27 # The size of the menu, must be a multiple of 9.
  title: "&bMy lovely menu" # The title of the menu.

Menu enabled/disabled

When creating a menu, you can either enable or disable this menu so its not able to be opened at all.

Here is an example on how to use the menu enable/disable, below in the example the status of the menu is enabled.

Configuration Example

menu: # The menu name goes here, you cannot change this.
  size: 27 # The size of the menu, must be a multiple of 9.
  title: "&bMy lovely menu" # The title of the menu.
  enabled: true # If the menu is disabled or not.

Menu Open Actions

When opening a menu, you can execute commands to happen. This happens after the menu has been opened. You can view the command actions and how to use them here.

Here is an example on how to use the menu open actions, below in the example it it'll say hey in chat when the menu is opened.

menu: # The menu name goes here, you cannot change this.
  size: 27 # The size of the menu, must be a multiple of 9.
  title: "&bMy lovely menu" # The title of the menu.
  enabled: true # If the menu is disabled or not.
  open-actions: # the actions when this menu is opened up
    - "[message] hey"

Menu Close Actions

When creating a menu, you can execute commands to happen. This happens after the menu has been closed. You can view the command actions and how to use them here.

Here is an example on how to use the menu close actions, below in the example it it'll say hey in chat when the menu is closed.

menu: # The menu name goes here, you cannot change this.
  size: 27 # The size of the menu, must be a multiple of 9.
  title: "&bMy lovely menu" # The title of the menu.
  enabled: true # If the menu is disabled or not.
  open-actions: # the actions when this menu is opened
    - "[message] hey"
  close-actions: # the actions when this menu is closed
    - "[message] hey"

Menu Open Requirements

When creating a menu, you can add certain requirements to only open the menu. If the requirement does not meet then it will not open the menu and execute denied commands. If the requirement is met, it will open the menu and execute success commands. Note, it will also execute the open actions if successful.

View more information about requirements here.

Here is an example on how to use the menu open requirements, below in the example the player needs the permission "menu.open" to open the menu

menu: # The menu name goes here, you cannot change this.
  size: 27 # The size of the menu, must be a multiple of 9.
  title: "&bMy lovely menu" # The title of the menu.
  enabled: true # If the menu is disabled or not.
  open-actions: # the actions when this menu is opened
    - "[message] hey"
  close-actions: # the actions when this menu is closed
    - "[message] hey"
  open-requirements:
    1:
      inverted: false
      cached: true
      permission: "menu.open"
      type: has permission
      deny-commands:
        - "[message] you don't have permission"
      success-commands:
        - "[message] you have permission"