Settings Menu

Here you'll find how to make your own settings menu from scratch.

General Sections

First, give your menu a custom name by adding a title (string) section. After that, you may configure other general options of your menu: previous-menu (boolean) to enable opening of previous menu when closing the menu; type (string) to set the inventory-type of the menu; open-sound (sound) for setting a custom sound when opening the menu.

You may find a list of valid inventory-types on this link.

Pattern Section

Let's work on the pattern section. The pattern section is the area where you can configure the layout of your menu. It is a list of strings that each char in them represents a different item that will be displayed in your menu. The pattern list should contain a list of 1 to 6 lines that each will have 9 chars - spaces are not counted as chars. If you have two same chars in different slots, then the items in these slots will be identical. Configuring how items will look like is not done here, but in the items section.

Paged-Type Menu Sections

The settings menu is a paged-menu, which means it displays items from a list of available items - in this case, the island settings (also known as island flags). Because the amount of settings can be greater than the amount of available slots, the menu supports multiple pages.

This type of menu requires 4 additional sections: slots - char of the setting buttons. previous-page - char to set a custom button that will get players back to the previous page. current-page - char to set a custom button that will display the current page players look at. next-page - char to set a custom button that will get players to the next page.

Settings Section

Besides the regular menu sections, the settings menu has a settings section, where all the settings of the menu are configured. Each setting has its own sub-section, with the name of the island flag as its key. Each setting section can have the following fields:

Field Name	Field Type	Description
display-menu	Boolean	Whether the setting should be displayed in the menu.
settings-enabled	Item-Section	The item that will be displayed when the setting is enabled.
settings-disabled	Item-Section	The item that will be displayed when the setting is disabled.
sound	Sound	A sound that will be played when the setting is toggled.

settings:
  always_day:
    display-menu: true
    settings-enabled:
      type: STAINED_CLAY
      data: 4
      name: '&6Always Day'
      lore:
        - '&7Set a day time on your island.'
        - '&7Currently &aENABLED&7.'
    settings-disabled:
      type: STAINED_CLAY
      data: 4
      name: '&6Always Day'
      lore:
        - '&7Set a day time on your island.'
        - '&7Currently &cDISABLED&7.'
    sound:
      type: ORB_PICKUP
      volume: 0.2
      pitch: 0.2

If a flag that exists in the plugin is missing from the settings section, a warning will be printed to the console. You can hide a setting from the menu without warnings by setting its display-menu field to false.

Items Section

That's the place where you configure your items. You can find a tutorial on how to properly configure an item here.

Custom Placeholders

The pagination items of the paged-menu support custom placeholders! previous-page, next-page - {0} - Green color (&a) if can navigate to the previous/next page, red color (&c) otherwise. current-page - {0} - The current's page number.

Sounds Section

In this section you can configure custom sounds that will be played when players click the items in the menu. You can find a tutorial on how to properly configure sounds here.

Commands Section

In this section you can configure custom commands that will be executed when players click the items in the menu. You can find a tutorial on how to properly configure commands here.

Permissions Section

In this section you can configure required-permissions for your items that players must have before they can click an item. You can find a tutorial on how to properly configure permissions here.

Menu Example

This is a shortened version of the default settings menu, which includes most of the technics and features stated in this tutorial.

title: '&lIsland Settings'
previous-menu: true

pattern:
  - '$ $ $ $ $ $ $ $ $'
  - '$ @ @ @ @ @ @ @ $'
  - '$ @ @ @ @ @ @ @ $'
  - '$ @ @ @ @ @ @ @ $'
  - '$ $ % $ * $ ^ $ $'

slots: '@'
previous-page: '%'
current-page: '*'
next-page: '^'

items:
  '$':
    type: STAINED_GLASS_PANE
    data: 3
    name: '&f'
  '%':
    type: PAPER
    name: '{0}Previous Page'
  '*':
    type: DOUBLE_PLANT
    name: '&aCurrent Page'
    lore:
      - '&7Page {0}'
  '^':
    type: PAPER
    name: '{0}Next Page'

settings:
  always_day:
    display-menu: true
    settings-enabled:
      type: STAINED_CLAY
      data: 4
      name: '&6Always Day'
      lore:
        - '&7Set a day time on your island.'
        - '&7Currently &aENABLED&7.'
    settings-disabled:
      type: STAINED_CLAY
      data: 4
      name: '&6Always Day'
      lore:
        - '&7Set a day time on your island.'
        - '&7Currently &cDISABLED&7.'
    sound:
      type: ORB_PICKUP
      volume: 0.2
      pitch: 0.2
  # ... more settings follow the same format ...