Skip to main content

GUI Pages

Custom Pages​

Custom pages are used in most of the plugins, and understanding how to correctly configure a GUI page is important to creating your menus.

How to make a page​

Pages consist of three key components, a mask, a pattern, and sometimes a page number. A pattern is the layout of the background or filler items. Think of the pattern section as the GUI, with 9 columns and up to 6 rows.

Patterns use a simple format: 0 is an empty slot. 1-9 are the first nine different filler items a-z is the remaining 26 items. In total you could display 35 different items as "filler" items in your GUI.

A mask is the items to be shown in the pattern layout, these work from the top down. You can use the Item Lookup System here to add custom items, apply names or any other of the options. The first item in the list will represent 1 in the pattern, the second item in the list is 2, etc..

Example Page Config​

    - page: 1
      mask:
        items: # The order of items to display
          - gray_stained_glass_pane # The 1st Item
          - black_stained_glass_pane # The 2nd Item
        pattern: 
          - "222222222"
          - "211111112"
          - "222222222"

This example has a surrounding layer of gray_stained_glass_pane and a center strip of black_stained_glass_pane.

Page

Custom GUI Slots​

What are custom GUI slots?​

When configuring a GUI in a plugin, you might stumble across this:

# Custom GUI slots; see here for a how-to: https://plugins.auxilor.io/all-plugins/pages#custom-gui-slots
custom-slots: []

This means you can add custom items (with commands) to your GUIs for that extra layer of customizability.

How to make a custom GUI slot​

Quite simply, a GUI slot looks like this:

custom-slots:
  - row: 6 
    column: 9
    item: ecoitems:skill_gui_item 
    lore: []
    left-click:
      - console:op %player% # Commands can start with console: to be ran by console, and use %player% as a placeholder.
      - spawn # If you don't specify, then the command will be ran by the player.
    right-click: []
    shift-left-click: []
    shift-right-click: []

If you have no right click / shift left click / etc.. commands to add, you can omit the sections, like this:

custom-slots:
  - row: 1
    column: 5
    item: player_head texture:eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvODU3MDVjZjg2NGRmMmMxODJlMzJjNDg2YjcxNDdjYmY3ODJhMGFhM2RmOGE2ZDYxNDUzOTM5MGJmODRmYjE1ZCJ9fX0=
    right-click:
      - console:eco give %player% 1000

And you can add as many custom slots as you want, like this:

custom-slots:
  - <slot 1>
  - <slot 2>
  - <slot 3>
  - ...etc