Menus

MythicCosmetics menus can be edited to look however you'd like!

Each menu's config file is located in the plugins/MythicMobs/config/cosmetics/menus folder. There are two main types of menus:

• customize.yml - The /customize menu, with a list of cosmetic types
• selection.yml - Menus for selecting specific cosmetics

Selection menus can also exist as selection_[cosmeticType].yml to customize the menu for each cosmetic type. If no type-specific menu exists, it will use the regular selection.yml generic menu.

Basic Menu Configuration

A default menu file looks something like this:

Menu:
  Display: "            &c&lMythicCosmetics"
  Size: 27
  Schema:
  - 1 1 1 1 1 1 1 1 1
  - 1 H B A E S O 0 1
  - 1 1 1 1 1 1 1 1 1
  Icons:
    FANCY_BORDER:
      Mapping: 1
      Material: BLACK_STAINED_GLASS_PANE
      Display: ''
      Model: 1
    BUTTON_HATS:
      Mapping: H
      Material: LEATHER_HELMET
      Display: '&6&lHats'
      Lore:
      - '&7Change your hat'

The layout of the menu is defined by the Schema. Each letter in the schema is mapped to an icon listed under the Icons configuration, where Mapping is the letter the icon will map to in the schema.

Customize Menu

In the customize menu, buttons with specific names will open the corresponding selection menu for each cosmetic type. These buttons should be named BUTTON_[TYPE], e.g. BUTTON_HATS would open the hats selection menu.

These mappings will work even for custom cosmetic types registered through the API.

Selection Menu

You may notice the selection menus contain $ symbols. These designate where any dynamic data will be loaded, in this case the list of different cosmetics.

Special buttons such as the page buttons and back button need to be named the same to work.

Special Buttons in cosmetics.yml:

• BUTTON_[TYPE] - clicking a button named this will open that cosmetic selection menu (such as BUTTON_HATS

Special Buttons in selection.yml:

• BACK - The back button
• NEXT_PAGE - Next button for pagination
• PREVIOUS_PAGE - Previous button for pagination
• EQUIPPED - Shows the currently equipped cosmetic
• REMOVE_COSMETIC - Removes the currently equipped cosmetic
• SEARCH - Lets you search thru cosmetics
• SEARCH_RESET - Resets the search functionality
• FILTER - A button that toggles between showing All cosmetics, Collected, and Favorites
• FILTER_ALL - Icon for the "Showing All" button (replaces the FILTER button, doesn't need to be mapped)
• FILTER_COLLECTED - Icon for the "Showing Collected" button (replaces the FILTER button, doesn't need to be mapped)
• FILTER_FAVORITES - Icon for the "Showing Favorites" button (replaces the FILTER button, doesn't need to be mapped)