Menu Customization

This guide explains how to customize your ShopMaster shop menus with categories, navigation buttons, and custom items.

Table of Contents

• Shop Configuration Basics

• Category Setup

• Navigation Buttons

  • Global Buttons

  • Page-Specific Buttons

• Custom Items Integration

Shop Configuration Basics

Each shop requires a basic setup with the following properties:

shop_name:
  enable: true                     # Enable or disable the shop
  title: '&8☀ Shop | &lWEAPONS'    # Shop title with color codes
  size: 54      

Category Setup

Categories appear in the main menu and allow players to navigate to specific shops:

shop_name:
  # ... basic shop config ...
  
  category:
    material: DIAMOND_SWORD        # Item to display in the main menu
    slot: 12                       # Slot in the main menu (0-53)
    amount: 1                      # Item stack size
    model_data: 0                  # Custom model data (for resource packs)
    display_name: '&bWeapons Shop' # Display name with color codes
    glowing: true                  # Add enchantment glow effect
    item_flags:                    # Item flags to hide attributes
      - HIDE_ATTRIBUTES
      - HIDE_ENCHANTS
    lore:                          # Item description
      - '&8ᴄᴀᴛᴇɢᴏʀɪᴇs'
      - ''
      - '&8 ● &fPurchase powerful weapons'
      - '&8 ● &fMagical and physical damage'
      - ''
      - '&e► Click to open the menu!'

Button System

Buttons for navigation and control in shops can be configured in two ways:

Default Buttons

In the layouts.yml file, default buttons are defined that will be used across all shops:

buttons:
  next:
    enabled: true
    material: ARROW
    slot: 50
    amount: 1
    model_data: 0
    display_name: '&cNext page'
    glowing: false
    item_flags:
      - HIDE_ATTRIBUTES
    lore: []

  previous:
    enabled: true
    material: ARROW
    slot: 48
    amount: 1
    model_data: 0
    display_name: '&cPrevious page'
    glowing: false
    item_flags:
      - HIDE_ATTRIBUTES
    lore: []

  close:
    enabled: true
    material: BOOK
    slot: 49
    amount: 1
    model_data: 0
    display_name: '&cClose'
    glowing: false
    item_flags:
      - HIDE_ATTRIBUTES
    lore: []

  back:
    enabled: true
    material: ARROW
    slot: 46
    amount: 1
    model_data: 0
    display_name: '&cBack'
    glowing: false
    item_flags:
      - HIDE_ATTRIBUTES
    lore: []

  indicator:
    enabled: true
    material: NETHER_STAR
    slot: 4
    amount: 1
    model_data: 0
    display_name: '&eCurrent'
    glowing: false
    item_flags:
      - HIDE_ATTRIBUTES
    lore: []

Category-Specific Customization

Each shop category can customize its own buttons by overriding the default buttons. To do this, simply add the buttons section in the category's configuration file:

tools:
  enable: true
  title: '&8☀ Shop | &lTOOLS'
  size: 54

  category:
    # Category configuration...

  buttons:
    # Here you can customize buttons for this specific category
    next:
      enabled: true
      material: SPECTRAL_ARROW  # Changed from ARROW to SPECTRAL_ARROW
      slot: 50
      amount: 1
      display_name: '&aNext Page'  # Custom name
      glowing: true  # Different from default

If the buttons section is empty (buttons: []) or doesn't exist, the default buttons from the layouts.yml file will be used.

Button Properties

Each button can be configured with the following properties:

• enabled: Activates or deactivates the button (true/false)

• material: The Minecraft item to be displayed

• slot: Position in the inventory (0-53)

• amount: Item stack size

• model_data: Custom model data for resource packs

• display_name: Display name (supports color codes)

• glowing: Enchantment glow effect (true/false)

• item_flags: Flags to hide attributes

• lore: Item description

Items

In this section you won't be able to add new items to the menu, only edit the current ones. If you want to add more items use the custom-items section

Item | Material

• Material name (DIAMOND).

• BaseHead (basehead-base64).
• Minecraft Texture (texture-<id>) - The id is what's after https://textures.minecraft.net/textures/

• HeadDatabase (hdb-<ID>).
• ItemsAdder material (itemsadder-namespace:name)
• Oraxen material (oraxen-oraxen_item_id)

Supported material values:

material: TEXT

Item | ItemFlags

There is an item_flags: section where you can add the necessary flags for your item.

item_flags:
  - HIDE_ATTRIBUTES

Custom Items

In this section you will be able to create your customized items. Each item you add in this section must have a different name.

Remember that to execute an action, you can read Actions to find out which one you need. For more information you can read ❔ FAQ

Section

For the custom items section, you will need to create a name identifier for the item, as shown in the following example: 'close'.

    custom-items:
      close:  # <-- Name ID
        material: BOOK
        amount: 1
        display_name: '&cClose'
        lore: [ ]
        slot: 49
        actions:
          - "[close]"

---

Slots

In this section, you can specify in which slots the articles will be created. Below are some examples of how to assign articles to different slots:

slot: 10 # <--  The item is created in slot 10
slots: [1-10] # <-- Create the item in slots 1 to 10
slots: # <-- Create the item in slots 1, 2 and 3
- 1
- 2
- 3

You can use these formats to customize item locations according to your needs.

---

Actions

Actions allow you to execute console commands, send messages, send titles, send messages in the bossbar and even use mini message

Remember that you can use placeholders in any action. For example %player_name%.

Prefix	Description
[message]	If the prefix is [message] and the player is not in parkour (or is a new player), a message is sent to the player.
[command]	If the prefix is [command] and the player is not in parkour, a server command is executed. You can use placeholder like %player_name% to get the player's name
[player]	If the prefix is [player] and the player is not in parkour, a chat action is performed for the player
[sound]	Send a sound to the player, add volume, pitch using ;
[broadcast]	Send a global message, to all connected players
[close]	Close the player's inventory
[openmenu]	You will be able to open an inventory menu using its section name in menus.yml
[title]	Uses the format Title;Subtitle;fadeint;stay;fadeout
[actionbar]	It will allow you to send a message in actionbar.
[minimessage]	It will allow you to send the minimessage format that will be sent to the player. https://docs.advntr.dev/minimessage/format.html
[minibroadcast]	It will allow you to send the mini-message format to all connected players. https://docs.advntr.dev/minimessage/format.html

    ##
    ## You can use {player} to get the name of the player or
    ##
    ## Remember to install PlaceholderAPI and load the expansion Player :
    ## /papi ecloud download Player or %player_name% will not work.
    ##
- '[command] eco give {player} 10000 <delay=40>'  # Gives 10,000 coins to the player after 40 ticks
#- '[chance=50] [command] say Hi {player}' # With a 50% probability, the server says "Hi" to the player.
#- '[player] /rewards' # Execute the /rewards command as the player
#- '[message] &aYou have correctly claimed your reward' # Sends a confirmation message to the player
#- '[sound] BLOCK_NOTE_BLOCK_HARP;1.0f;1.0f' # Plays a sound to the player SOUND;YAW;PITCH
#- '[broadcast] &8» &eThe player &7{player} &ehas claimed his &7Basic &ereward using &7&o(&a/rewards&7)'  # Public message announcing the reward
#- '[title] &a&lCLAIMED;&fsuccess;10;20;10' # Displays a title to the player
#- '[close]' # Closes the player's inventory
#- '[actionbar] &aYou have correctly claimed your reward' # Send a message in the actionbar to the player

# MiniMessage > https://docs.advntr.dev/minimessage/format.html#minimessage-format
#- '[minimessage] <MiniMessage>'
#- '[minibroadcast] <MiniMessage>'

---

Sub Actions

Examples:

It is important to maintain the space between chance and action.

Prefix	Description
[chance=50]	Add chance to your action
<delay=20>	Add a delay to your actions.

actions:
 - "[chance=50] [command] say Hi %player_name%"

actions:
 - "[command] say Hi %player_name% <delay=20>"