Setup

This page explains how to set up a custom menu using a configuration file. The menu system allows you to display custom graphical menus with clickable items.

In the menu folder, you can create as many subfolders as you want. However, within the entire menu folder, you cannot have two YAML files with the same name.

📝 Basic Structure

title

  • Description: Sets the title that appears at the top of the menu.

  • Example:

    title: '&eExample Menu'

🗺️ Menu Layout (item-map)

The item-map defines the visual layout of your menu. Each line represents a row in the menu grid. You can use any character (letter, number, or symbol) to represent a specific item.

  • Each character corresponds to an item in the items section.

  • Use - for empty or decorative slots.

Example:

item-map:
  - '-ggggggg-'
  - '2-WWWWW-1'
  - '-gggCggg-'

In this layout:

  • g is a gray glass pane (usually used as a filler).

  • W could represent a wood item (defined in the pagination).

  • 1 and 2 are pagination buttons.

  • C is a close menu button.

🔄 Pagination Support

The pagination section allows your menu to support multiple pages of items.

category

  • Used to link the menu to a specific group of items.

  • The name must match a pagination category defined elsewhere.

  • Example:

    category: 'wood'

next and previous

Configure buttons to switch between pages.

Example:

next:
  item-slot-id: '1'
  empty: # Empty item for the next button
    material: BLACK_STAINED_GLASS_PANE # Material for the empty item
    name: '&7' # Name for the empty item
  material: ARROW # Material for the next button
  name: '&aNext page' # Name for the next button
  lore: # Lore for the next button
    - '&7Click to go to the next page'

  • item-slot-id: Refers to the character in item-map used for the button (in this case, 1).

  • empty: What to show when there's no next/previous page. You can delete a section if you don't want to use it, it's optional.

🧱 Items Section (items)

Each item character from the item-map must have a definition here. How to set up the item itself can be found here

Example:

items:
  'g':
    material: 'GRAY_STAINED_GLASS_PANE'
    name: '&r'
  'C':
    material: 'BARRIER'
    name: '&cClose Menu'
    lore:
      - ''
      - '&f» Click to close the menu'
    actions:
      - close-inv: true

✅ Final Notes

  • Every character used in item-map must be defined under items or in the pagination.

  • This system supports dynamic items (like pagination) and static buttons (like closing).

  • Use color codes (e.g., &a, &e, &c) to customize the text appearance.

PreviousEntitiesNextItem

Last updated