Menu Types

Shared keys

title: Menu title
type: Menu type
size: Multiple of 9, from 9 to 54

SIMPLE

Static layout, no pages.

simple-main:
  title: '&8Main Menu'
  type: SIMPLE
  size: 27

  items:
    profile:
      material: PLAYER_HEAD
      name: '&aProfile'
      slot: 11
    close:
      material: BARRIER
      name: '&cClose'
      slot: 15
      actions:
        - 'left: close'

PAGINATION

Single paginated list.

items-browser:
  title: '&8Items &7(%current_page%/%total_pages%)'
  type: PAGINATION
  size: 54

  pagination:
    slots: '10-16,19-25,28-34,37-43'

    item_template:
      material: '%item_material%'
      name: '&f%item_name%'
      lore:
        - '&7Page %current_page%/%total_pages%'
        - '&8Index: %index%'

    navigation:
      previous:
        slot: 48
        material: ARROW
        name: '&ePrevious'
      info:
        slot: 49
        material: PAPER
        name: '&7Page %current_page%/%total_pages%'
      next:
        slot: 50
        material: ARROW
        name: '&eNext'

MULTI_PAGINATION

Multiple independent sections with their own pages.

multi-browser:
  title: '&8Multi Browser'
  type: MULTI_PAGINATION
  size: 54

  sections:
    kits:
      slots: '10-16'
      navigation:
        previous:
          slot: 9
          material: ARROW
          name: '&ePrev kits'
        info:
          slot: 13
          material: PAPER
          name: '&7Kits %section_page%/%section_total_pages%'
        next:
          slot: 17
          material: ARROW
          name: '&eNext kits'

    effects:
      slots: '28-34'
      navigation:
        previous:
          slot: 27
          material: ARROW
          name: '&ePrev effects'
        info:
          slot: 31
          material: PAPER
          name: '&7Effects %section_page%/%section_total_pages%'
        next:
          slot: 35
          material: ARROW
          name: '&eNext effects'

FULL_INVENTORY

Includes player inventory flow with snapshot support.

full-editor:
  title: '&8Inventory Editor'
  type: FULL_INVENTORY
  size: 54

  player_inventory:
    enabled: true
    allowed_slots: '0-8'

  snapshot:
    enabled: true
    snapshot_id: 'editor_main'
    restore_on_close: true

PAGINATION_FULL

Pagination + full inventory snapshot behavior.

full-pagination:
  title: '&8Paged Inventory &7(%current_page%/%total_pages%)'
  type: PAGINATION_FULL
  size: 54

  snapshot:
    enabled: true
    snapshot_id: 'paged_editor'
    restore_on_close: true

  pagination:
    slots: '10-16,19-25,28-34,37-43'

MULTI_PAGINATION_FULL

Multi-section pagination + snapshot behavior.

full-multi:
  title: '&8Multi Full Editor'
  type: MULTI_PAGINATION_FULL
  size: 54

  snapshot:
    enabled: true
    snapshot_id: 'multi_editor'
    restore_on_close: true

  sections:
    left_section:
      slots: '10-16'
    right_section:
      slots: '28-34'

ITEM_INPUT

Collect items through editable GUI slots.

item-input:
  title: '&8Configure Items'
  type: ITEM_INPUT
  size: 54

  editable_slots: '10-16,19-25,28-34'

  items:
    confirm:
      material: EMERALD
      name: '&aConfirm'
      slot: 49
      actions:
        - 'left: close'

Menu Types

On this page