zMenu

https://docs.groupez.dev/zmenu/
Admin
zMenu is the most powerful and flexible inventory (GUI) plugin for Minecraft servers. It allows you...
Tokens:185,965
Snippets:1,833
Trust Score:7.5
Update:6 days ago
Show doc for...
Tokens:
Raw
### Player data command examples

Source: https://docs.groupez.dev/zmenu/configurations/commands-permissions

Examples of using /zm players to set, add, subtract, get, list keys, and clear player data.

```text
/zm players set Notch coins 100  
/zm players add Notch coins 50  
/zm players subtract Notch coins 10  
/zm players get Notch coins  
/zm players keys Notch  
/zm players clearplayer Notch  

```

--------------------------------

### Multiple Command Files Example

Source: https://docs.groupez.dev/zmenu/configurations/custom-commands

Example of a command file (shop_commands.yml) defining 'shop' and 'buyweapons' commands, each with its own inventory.

```yaml
# commands/shop/shop_commands.yml  
commands:  
  shop:  
    command: shop  
    inventory: shop_main  
  
  buyweapons:  
    command: /buyweapons  
    inventory: shop_weapons  

```

--------------------------------

### Open inventory examples

Source: https://docs.groupez.dev/zmenu/configurations/commands-permissions

Examples of using /zm open to open an inventory for yourself, another player, or with arguments.

```text
/zm open shop  
/zm open shop Notch  
/zm open shop Notch "Welcome to the shop!"  

```

--------------------------------

### Basic Home Button example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/types/home

A HOME button with a NETHER_STAR material and a teleport sound. This is a simple example from the Examples section.

```yaml
items:  
  home:  
    type: HOME  
    slot: 49  
    item:  
      material: NETHER_STAR  
      name: "&e&lHome"  
    sound: ENTITY_ENDERMAN_TELEPORT  

```

--------------------------------

### Complete commands.yml Example

Source: https://docs.groupez.dev/zmenu/configurations/custom-commands

A full example of the commands.yml file defining multiple custom commands with aliases, permissions, and actions. Each command maps to an inventory and optional permission.

```yaml
# commands/commands.yml  
commands:  
  # Main server menu  
  menu:  
    command: menu  
    inventory: main_menu  
    aliases:  
      - gui  
      - server  
    actions:  
      - type: sound  
        sound: BLOCK_CHEST_OPEN  
  
  # Shop with permission  
  shop:  
    command: shop  
    inventory: shop_main  
    permission: "server.shop"  
    aliases:  
      - store  
      - market  
      - buy  
  
  # VIP shop  
  vipshop:  
    command: /vipshop  
    inventory: vip_shop  
    permission: "server.vip.shop"  
    aliases:  
      - vs  
  
  # Warps menu  
  warps:  
    command: warps  
    inventory: warps_menu  
    permission: "server.warps"  
    aliases:  
      - warp  
      - w  
  
  # Player profile  
  profile:  
    command: /profile  
    inventory: player_profile  
    aliases:  
      - stats  
      - me  
  
  # Help menu  
  help:  
    command: /serverhelp  
    inventory: help_menu  
    aliases:  
      - faq  
      - info  
  
  # Admin panel  
  admin:  
    command: /adminpanel  
    inventory: admin_menu  
    permission: "server.admin"  
    aliases:  
      - ap  
      - adminmenu  

```

--------------------------------

### Material Loader Examples

Source: https://docs.groupez.dev/zmenu/configurations/items/item

Examples of using different material loaders: vanilla, player head, zHead, ItemsAdder, and Oraxen.

```yaml
# Vanilla material  
material: DIAMOND_SWORD  
  
# Player head  
material: "playerHead:%player%"  
  
# Custom head from zHead  
material: "zhd:123"  
  
# ItemsAdder custom item  
material: "itemsadder:my_namespace:ruby_gem"  
  
# Oraxen custom item  
material: "oraxen:amethyst_sword"  

```

--------------------------------

### Actions Configuration Example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/button

Defines actions executed when the button is clicked. The example includes a message action and a sound action.

```yaml
items:  
  button:  
    slot: 0  
    item:  
      material: EMERALD  
    actions:  
      - type: message  
        messages:  
          - "&aYou clicked!"  
      - type: sound  
        sound: UI_BUTTON_CLICK  

```

--------------------------------

### Complete Currency System Example

Source: https://docs.groupez.dev/zmenu/development/api-player-data

A full CurrencyManager class using MenuPlugin and DataManager. It provides methods to get, set, add, remove, and check coins, storing values as strings and clamping to non-negative amounts.

```java
package com.example.currency;  
  
import fr.maxlego08.menu.api.MenuPlugin;  
import fr.maxlego08.menu.api.DataManager;  
import org.bukkit.entity.Player;  
  
public class CurrencyManager {  
  
    private final DataManager dataManager;  
    private static final String COINS_KEY = "coins";  
  
    public CurrencyManager(MenuPlugin menuPlugin) {  
        this.dataManager = menuPlugin.getDataManager();  
    }  
  
    public int getCoins(Player player) {  
        return dataManager.getData(player, COINS_KEY)  
            .map(Integer::parseInt)  
            .orElse(0);  
    }  
  
    public void setCoins(Player player, int amount) {  
        dataManager.setData(player, COINS_KEY, String.valueOf(Math.max(0, amount)));  
    }  
  
    public void addCoins(Player player, int amount) {  
        int current = getCoins(player);  
        setCoins(player, current + amount);  
    }  
  
    public boolean removeCoins(Player player, int amount) {  
        int current = getCoins(player);  
        if (current >= amount) {  
            setCoins(player, current - amount);  
            return true;  
        }  
        return false;  
    }  
  
    public boolean hasCoins(Player player, int amount) {  
        return getCoins(player) >= amount;  
    }  
}  

```

--------------------------------

### Example Action Pattern File

Source: https://docs.groupez.dev/zmenu/configurations/patterns

Shipped example file 'actions_patterns/default-actions.yml'. When applied, every button plays ENTITY_VILLAGER_YES on success and ENTITY_VILLAGER_NO on denial, unless overridden.

```yaml
name: default-actions  
actions:  
  - type: sound  
    sound: ENTITY_VILLAGER_YES  
deny-actions:  
  - type: sound  
    sound: ENTITY_VILLAGER_NO  

```

--------------------------------

### Example: Decoration pattern file

Source: https://docs.groupez.dev/zmenu/configurations/patterns

A shipped example of an inventory pattern file that places a permanent decoration item in corner slots.

```yaml
name: "pattern_example"
size: 54
items:
  example1:
    isPermanent: true
    item:
      material: IRON_INGOT
      name: "&fExample of pattern"
    slots:
      - 0
      - 8
      - 45
      - 53
```

--------------------------------

### Reload command examples

Source: https://docs.groupez.dev/zmenu/configurations/commands-permissions

Examples of using /zm reload to reload all configurations, a specific inventory, or a specific command.

```text
/zm reload  
/zm reload inventory shop  
/zm reload command warp  

```

--------------------------------

### Player list example with navigation

Source: https://docs.groupez.dev/zmenu/configurations/buttons/types/dynamic-pagination

Complete example showing a DYNAMIC_PAGINATION button for online players, plus PREVIOUS and NEXT navigation buttons and a page info button. Uses the 'online_players' source and includes a player-command action.

```yaml
size: 54  
name: "&8Online Players"  
  
items:  
  player-list:  
    type: DYNAMIC_PAGINATION  
    slots:  
      - 10-16  
      - 19-25  
      - 28-34  
    source: "online_players"  
    item:  
      material: PLAYER_HEAD  
      player-head: "%entry_name%"  
      name: "&a&l%entry_name%"  
      lore:  
        - "&7Click to view profile"  
    actions:  
      - type: player-command  
        commands:  
          - "profile %entry_name%"  
  
  # Navigation  
  previous:  
    type: PREVIOUS  
    slot: 48  
    is-permanent: true  
    item:  
      material: ARROW  
      name: "&c&lPrevious"  
  
  next:  
    type: NEXT  
    slot: 50  
    is-permanent: true  
    item:  
      material: ARROW  
      name: "&a&lNext"  
  
  # Page info  
  info:  
    slot: 49  
    is-permanent: true  
    item:  
      material: PAPER  
      name: "&7Page %page%/%max_page%"  

```

--------------------------------

### Complete zMenu Integration Example Plugin (Java)

Source: https://docs.groupez.dev/zmenu/development/api-introduction

A complete JavaPlugin example that hooks into zMenu on enable, checks for null and disables the plugin if missing, and opens a zMenu inventory via the InventoryManager when a command is executed. Requires zMenu as a dependency and uses the 'my-menu' inventory identifier.

```java
package com.example.myplugin;  
  
import fr.maxlego08.menu.api.MenuPlugin;  
import fr.maxlego08.menu.api.InventoryManager;  
import org.bukkit.Bukkit;  
import org.bukkit.command.Command;  
import org.bukkit.command.CommandSender;  
import org.bukkit.entity.Player;  
import org.bukkit.plugin.java.JavaPlugin;  
  
public class MyPlugin extends JavaPlugin {  
  
    private MenuPlugin menuPlugin;  
  
    @Override  
    public void onEnable() {  
        // Hook into zMenu  
        this.menuPlugin = (MenuPlugin) Bukkit.getPluginManager().getPlugin("zMenu");  
  
        if (this.menuPlugin == null) {  
            getLogger().severe("zMenu is required!");  
            Bukkit.getPluginManager().disablePlugin(this);  
            return;  
        }  
  
        getLogger().info("MyPlugin enabled with zMenu integration!");  
    }  
  
    @Override  
    public boolean onCommand(CommandSender sender, Command command,  
                            String label, String[] args) {  
        if (!(sender instanceof Player)) {  
            sender.sendMessage("Players only!");  
            return true;  
        }  
  
        Player player = (Player) sender;  
        InventoryManager manager = menuPlugin.getInventoryManager();  
  
        // Open a zMenu inventory  
        manager.getInventory("my-menu").ifPresent(inv -> {  
            manager.openInventory(player, inv);  
        });  
  
        return true;  
    }  
}  
```

--------------------------------

### PlaceholderAPI item configuration example

Source: https://docs.groupez.dev/zmenu/supported-plugins

YAML configuration for an inventory item using PlaceholderAPI placeholders in name and lore. Requires PlaceholderAPI to be installed. Placeholders like %player_name% and %vault_eco_balance% are resolved dynamically.

```yaml
item:  
  material: DIAMOND  
  name: "&6%player_name%'s Menu"  
  lore:  
    - "&7Balance: &a$%vault_eco_balance%"  
    - "&7Playtime: &e%statistic_hours_played%h"  

```

--------------------------------

### click-requirements alias example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/button

Same as click-requirement example but uses the alias 'click-requirements'.

```yaml
items:  
  purchase-button:  
    slot: 0  
    click-requirements:  
      default:  
        clicks:  
          - ALL  
        requirements:  
          - type: placeholder  
            placeholder: "%vault_eco_balance%"  
            action: SUPERIOR_OR_EQUAL  
            value: 100  
            deny:  
              - type: message  
                messages:  
                  - "&cYou need $100 to purchase this!"  
              - type: sound  
                sound: ENTITY_VILLAGER_NO  
        success:  
          - type: message  
            messages:  
              - "&aPurchase successful!"  
          - type: console-command  
            commands:  
              - "eco take %player% 100"  

```

--------------------------------

### Basic Previous Button example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/types/previous

Example of a PREVIOUS button with is-permanent: true, a sound on click, and a simple arrow item.

```yaml
items:  
  previous:  
    type: PREVIOUS  
    slot: 45  
    is-permanent: true  
    item:  
      material: ARROW  
      name: "&c&l← Previous"  
    sound: UI_BUTTON_CLICK  

```

--------------------------------

### PlaceholderAPI Debugging Commands

Source: https://docs.groupez.dev/zmenu/configurations/placeholders

Commands to debug placeholders: check PlaceholderAPI is installed, test a placeholder, check the expansion is installed, and install missing expansions. Run these in the server console or in-game.

```text
/papi info  

```

```text
/papi parse me %placeholder_name%  

```

```text
/papi list  

```

```text
/papi ecloud download <expansion>  
/papi reload  

```

--------------------------------

### Action pattern file example

Source: https://docs.groupez.dev/zmenu/configurations/inventories/inventory

Example of an action pattern file (default-actions.yml) that defines actions and deny-actions. When applied, all buttons inherit these actions.

```yaml
name: default-actions  
actions:  
  - type: sound  
    sound: ENTITY_VILLAGER_YES  
deny-actions:  
  - type: sound  
    sound: ENTITY_VILLAGER_NO  
```

--------------------------------

### key property example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/types/switch

Example of the 'key' property, which is required and specifies the placeholder to evaluate for determining which button to display.

```yaml
key: "%zmenu_player_value_setting%"  

```

--------------------------------

### Give item to yourself example

Source: https://docs.groupez.dev/zmenu/configurations/items/custom-items

Example command to give the item with id 'legendary-sword' to yourself. Requires the zmenu.give.item permission.

```text
/zmenu giveitem legendary-sword
```

--------------------------------

### Custom Material Examples for Various Plugins

Source: https://docs.groupez.dev/zmenu/supported-plugins

Examples of custom material syntax for different plugins: ItemsAdder, Oraxen/Nexo, HeadDatabase, Slimefun, MythicMobs, MMOItems, ExecutableItems/ExecutableBlocks, zItems, and the built-in armor:HEAD for player's equipped item.

```yaml
# ItemsAdder  
item:  
  material: itemsadder:my_namespace:ruby  
  
# Oraxen / Nexo  
item:  
  material: oraxen:emerald_sword  
  # material: nexo:emerald_sword  
  
# HeadDatabase  
item:  
  material: hdb:1234  
  
# Slimefun  
item:  
  material: slimefun:ELECTRIC_MOTOR  
  
# MythicMobs  
item:  
  material: mythicmobs:SkeletonKingSword  
  
# MMOItems  
item:  
  material: mmoitems:SWORD:LEGENDARY_BLADE  
  
# ExecutableItems / ExecutableBlocks  
item:  
  material: ei:my_custom_item  
  # material: eb:my_custom_block  
  
# zItems  
item:  
  material: zitems:my_item_id  
  
# Player's equipped item (built-in)  
item:  
  material: armor:HEAD  

```

--------------------------------

### Basic Back Button example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/types/back

Example of a BACK button with a sound effect on click. Uses an arrow item and the UI_BUTTON_CLICK sound.

```yaml
items:  
  back:  
    type: BACK  
    slot: 45  
    item:  
      material: ARROW  
      name: "&c&lBack"  
    sound: UI_BUTTON_CLICK  

```

--------------------------------

### Simple form configuration example

Source: https://docs.groupez.dev/zmenu/configurations/bedrock

Example YAML configuration for a simple Bedrock form with three buttons. Buttons can include optional images via URL or resource pack path, and each button defines click requirements with success actions. The placeholder %content% is available in click actions.

```yaml
type: simple  
name: "Simple Form"  
  
buttons:  
  button1:  
    type: "bedrock_button"  
    text: "Button 1"  
    click-requirement:  
      1:  
        success:  
          - type: message  
            messages:  
              - "&aAction for button 1"  
  button2:  
    type: "bedrock_button"  
    text: "Button 2"  
    image-type: "URL"  
    image-value: "https://github.com/GeyserMC.png?size=200"  
    click-requirement:  
      1:  
        success:  
          - type: message  
            messages:  
              - "&aAction for button 2"  
  button3:  
    type: "bedrock_button"  
    text: "Button 3"  
    image-type: "PATH"  
    image-value: "textures/i/glyph_world_template.png"  
    click-requirement:  
      1:  
        success:  
          - type: message  
            messages:  
              - "&aAction for button 3"  

```

--------------------------------

### Give item to another player example

Source: https://docs.groupez.dev/zmenu/configurations/items/custom-items

Example command to give the item with id 'legendary-sword' to the player 'Notch'. Requires the zmenu.give.item permission.

```text
/zmenu giveitem legendary-sword Notch
```

--------------------------------

### datas configuration example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/button

Defines player-data operations at the button level. The datas list runs like a data action, with key, action, value, math, and seconds options. The example increments a 'clicks' counter.

```yaml
items:  
  counter:  
    slot: 0  
    datas:  
      - key: "clicks"  
        action: ADD  
        value: "1"  
        math: false     # Enable math expressions in value (default: false)  
        seconds: 0      # If > 0, data expires after this many seconds (default: 0)  
    item:  
      material: PAPER  
      name: "&eClicks: %zmenu_player_value_clicks%"  

```

--------------------------------

### itemjoin mechanic example

Source: https://docs.groupez.dev/zmenu/configurations/items/mechanics

Example of the itemjoin mechanic granting a server guide item on first join, locking it to slot 8, and preventing inventory modification.

```yaml
server-guide:  
  material: FILLED_MAP  
  name: "&eServer Guide"  
  lore:  
    - "&7Everything you need to get started."  
  mechanics:  
    itemjoin:  
      give-first-join: true  
      fixed-slot: 8  
      prevent-inventory-modification: true  

```

--------------------------------

### Get InventoryManager instance

Source: https://docs.groupez.dev/zmenu/development/api-inventory

Retrieve the InventoryManager from the menu plugin to start working with inventories.

```java
InventoryManager manager = menuPlugin.getInventoryManager();  
```

--------------------------------

### Get Inventory by Name and Plugin Name

Source: https://docs.groupez.dev/zmenu/development/api-inventory

Retrieves an inventory from a specific plugin by its name. Includes an example for the zAuctionHouse plugin.

```java
// Get inventory from a specific plugin by name  
Optional<Inventory> inventory = manager.getInventory("shop", "MyPlugin");  
  
// Example: Get inventory from zAuctionHouse plugin  
Optional<Inventory> auctionInventory = manager.getInventory("auction", "zAuctionHouse");  
  
auctionInventory.ifPresent(inv -> {  
    manager.openInventory(player, inv);  
});  

```

--------------------------------

### dialog-dynamic-body-button example

Source: https://docs.groupez.dev/zmenu/configurations/dialogues

Repeats a body element (e.g. dialog_plain_message) from start to end. The %index% placeholder is replaced with the current iteration number.

```yaml
body:  
  dynamic_message:  
    type: dialog-dynamic-body-button  
    start: 1  
    end: 5  
    body:  
      type: dialog_plain_message  
      messages:  
        - "&eThis is body section #%index%"  
      width: 300  

```

--------------------------------

### Complete Example: Plugin Integration

Source: https://docs.groupez.dev/zmenu/development/api-inventory

A complete InventoryService class that demonstrates opening inventories registered by this plugin or another plugin, with support for pagination and navigation history.

```java
public class InventoryService {  
  
    private final Plugin plugin;  
    private final InventoryManager inventoryManager;  
  
    public InventoryService(Plugin plugin, MenuPlugin menuPlugin) {  
        this.plugin = plugin;  
        this.inventoryManager = menuPlugin.getInventoryManager();  
    }  
  
    /**  
     * Opens an inventory registered by this plugin  
     */  
    public void openOwnInventory(Player player, String inventoryName) {  
        inventoryManager.getInventory(plugin, inventoryName).ifPresent(inv -> {  
            inventoryManager.openInventory(player, inv);  
        });  
    }  
  
    /**  
     * Opens an inventory registered by another plugin  
     */  
    public void openExternalInventory(Player player, String pluginName, String inventoryName) {  
        inventoryManager.getInventory(inventoryName, pluginName).ifPresent(inv -> {  
            inventoryManager.openInventory(player, inv);  
        });  
    }  
  
    /**  
     * Opens an inventory with pagination support  
     */  
    public void openInventoryAtPage(Player player, String inventoryName, int page) {  
        inventoryManager.getInventory(plugin, inventoryName).ifPresent(inv -> {  
            inventoryManager.openInventory(player, inv, page);  
        });  
    }  
  
    /**  
     * Opens an inventory preserving the navigation history  
     * Allows players to go back to previous inventories  
     */  
    public void openWithHistory(Player player, String inventoryName, int page) {  
        inventoryManager.getInventory(plugin, inventoryName).ifPresent(inv -> {  
            inventoryManager.openInventoryWithOldInventories(player, inv, page);  
        });  
    }  
}  

```

--------------------------------

### Register paginate button with NoneLoader

Source: https://docs.groupez.dev/zmenu/development/api-paginate-button

Use NoneLoader to register a paginate button. The example shows how to get the zMenu plugin and register the button with a custom class and identifier.

```java
@Override  
public void onEnable() {  
    MenuPlugin menuPlugin = (MenuPlugin) Bukkit.getPluginManager().getPlugin("zMenu");  
  
    if (menuPlugin != null) {  
        ButtonManager buttonManager = menuPlugin.getButtonManager();  
  
        // Register with NoneLoader for buttons with only a Plugin constructor  
        buttonManager.register(new NoneLoader(this, MyPaginatedButton.class, "MY_PAGINATED_BUTTON"));  
    }  
}  

```

--------------------------------

### dialog-dynamic-input-button example

Source: https://docs.groupez.dev/zmenu/configurations/dialogues

Repeats an input element (e.g. dialog_text) from start to end. Each generated input is keyed <button-name>_<index>, so its submitted value is available as the placeholder %<button-name>_<index>%.

```yaml
inputs:  
  # If the player types "Hello" in the first field, %my_input_1% will be "Hello"  
  my_input:  
    type: dialog-dynamic-input-button  
    start: 1  
    end: 3  
    input:  
      type: dialog_text  
      label: "&6Enter value #%index%:"  
      width: 300  
      max-length: 50  

```

--------------------------------

### Combining and + or requirements example

Source: https://docs.groupez.dev/zmenu/configurations/requirements

Shows a full menu item configuration that requires permission A and B (and block) plus permission C or D (or block with minimum: 1). Each sub-requirement has its own success and deny actions for feedback.

```yaml
name: "&8Test And/Or"  
size: 54  
items:  
  test:  
    slot: 22  
    view-requirement:  
      requirements:  
        - type: and  
          requirements:  
            - type: permission  
              permission: zmenu.test  
              success:  
                - type: message  
                  messages:  
                    - "&7Test And 1 - &aOK"  
              deny:  
                - type: message  
                  messages:  
                    - "&7Test And 1 - &cKO"  
            - type: permission  
              permission: zmenu.test2  
              success:  
                - type: message  
                  messages:  
                    - "&7Test And 2 - &aOK"  
              deny:  
                - type: message  
                  messages:  
                    - "&7Test And 2 - &cKO"  
        - type: or  
          minimum: 1  
          random: true  
          requirements:  
            - type: permission  
              permission: zmenu.test3  
              success:  
                - type: message  
                  messages:  
                    - "&7Test Or 1 - &aOK"  
              deny:  
                - type: message  
                  messages:  
                    - "&7Test Or 1 - &cKO"  
            - type: permission  
              permission: zmenu.test4  
              success:  
                - type: message  
                  messages:  
                    - "&7Test Or 2 - &aOK"  
              deny:  
                - type: message  
                  messages:  
                    - "&7Test Or 2 - &cKO"  
    item:  
      material: PAPER  
      name: "&aTest And/Or"  
    else:  
      item:  
        material: PAPER  
        name: "&cTest And/Or"  

```

--------------------------------

### Example: Navigation with pagination pattern

Source: https://docs.groupez.dev/zmenu/configurations/patterns

A pattern file with NEXT and PREVIOUS buttons. Requires 'enableMultiPage: true' for the buttons to function with pagination.

```yaml
name: "pagination"
size: 54
enableMultiPage: true
items:
  next:
    type: NEXT
    slot: 52
    is-permanent: true
    item:
      material: PAPER
      name: "&fNext Page"

  previous:
    type: PREVIOUS
    slot: 49
    is-permanent: true
    item:
      material: PAPER
      name: "&fPrevious Page"
```

--------------------------------

### click_requirement alias example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/button

Same as click-requirement example but uses the alias 'click_requirement'.

```yaml
items:  
  purchase-button:  
    slot: 0  
    click_requirement:  
      default:  
        clicks:  
          - ALL  
        requirements:  
          - type: placeholder  
            placeholder: "%vault_eco_balance%"  
            action: SUPERIOR_OR_EQUAL  
            value: 100  
            deny:  
              - type: message  
                messages:  
                  - "&cYou need $100 to purchase this!"  
              - type: sound  
                sound: ENTITY_VILLAGER_NO  
        success:  
          - type: message  
            messages:  
              - "&aPurchase successful!"  
          - type: console-command  
            commands:  
              - "eco take %player% 100"  

```

--------------------------------

### view_requirement alias example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/button

Same as the view-requirement example but uses the alias 'view_requirement'.

```yaml
items:  
  vip-only:  
    slot: 0  
    view_requirement:  
      requirements:  
        - type: permission  
          permission: "server.vip"  
    item:  
      material: DIAMOND  
      name: "&b&lVIP Item"  

```

--------------------------------

### open-async configuration example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/button

Sets open-async to true so that the inventory opened by clicking this button is scheduled asynchronously. Useful when the inventory open involves slow operations.

```yaml
items:  
  async-open:  
    slot: 0  
    open-async: true  
    type: INVENTORY  
    inventory: slow_menu  
    item:  
      material: COMPASS  

```

--------------------------------

### Hopper inventory example

Source: https://docs.groupez.dev/zmenu/configurations/inventories/inventory

Example of a HOPPER type inventory. The size option is ignored for non-CHEST types.

```yaml
name: "&8Quick Select"  
type: HOPPER  
  
items:  
  option1:  
    slot: 0  
    item:  
      material: DIAMOND  
      name: "&bOption 1"  

```

--------------------------------

### /zm players get <player> <key>

Source: https://docs.groupez.dev/zmenu/configurations/commands-permissions

Gets a player data value. Requires the zmenu.players.get permission.

```APIDOC
## /zm players get <player> <key>

### Description
Get a player data value

### Method
COMMAND

### Endpoint
/zm players get <player> <key>

### Parameters
#### Path Parameters
- **player** (string) - Required - The player whose data to get
- **key** (string) - Required - The data key

### Permission
zmenu.players.get

### Response
Player data value returned
```

--------------------------------

### Basic Main Menu Button example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/types/mainmenu

A basic MAIN_MENU button with a NETHER_STAR icon and a click sound.

```yaml
items:  
  main-menu:  
    type: MAIN_MENU  
    slot: 49  
    item:  
      material: NETHER_STAR  
      name: "&6&lMain Menu"  
    sound: UI_BUTTON_CLICK  

```

--------------------------------

### Example: Decoration usage in inventory

Source: https://docs.groupez.dev/zmenu/configurations/patterns

Shows how to apply the decoration pattern in an inventory by referencing its name in the 'patterns' list.

```yaml
name: "&eExample"
size: 54
patterns:
  - "pattern_example"

items:
  # ...
```

--------------------------------

### Item Configuration Example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/button

Configures the visual appearance of a button, including material, name, and lore.

```yaml
items:  
  button:  
    slot: 0  
    item:  
      material: DIAMOND  
      name: "&b&lDiamond"  
      lore:  
        - "&7A shiny diamond"  

```

--------------------------------

### Example output of /zm convert deluxemenus

Source: https://docs.groupez.dev/zmenu/convert-deluxemenus

Shows the console output when converting multiple menus. It lists each menu with a checkmark or cross, notes conversion issues, and ends with a summary and instruction to run /zm reload.

```text
✔ shop → inventories/converted/deluxemenu/shop.yml + command  
✔ ranks → inventories/converted/deluxemenu/ranks.yml + command (2 not converted exactly, see the top of the file)  
✘ broken: this is not a DeluxeMenus menu  
Converted 2/3 menus. Review them, then run /zm reload to load them.  

```

--------------------------------

### Event Priority Examples

Source: https://docs.groupez.dev/zmenu/development/api-events

Three examples showing how to use @EventHandler with different priorities: LOWEST to run first, HIGHEST to run last, and MONITOR with ignoreCancelled = false to observe even cancelled events. The MONITOR example is for observation only and should not modify the event.

```java
// Run first (before other plugins)  
@EventHandler(priority = EventPriority.LOWEST)  
public void onMenuOpenFirst(PlayerOpenInventoryEvent event) {  
    // ...  
}  
```

```java
// Run last (after other plugins)  
@EventHandler(priority = EventPriority.HIGHEST)  
public void onMenuOpenLast(PlayerOpenInventoryEvent event) {  
    // ...  
}  
```

```java
// Run even if cancelled  
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = false)  
public void onMenuOpenMonitor(PlayerOpenInventoryEvent event) {  
    // Just observe, don't modify  
}  
```

--------------------------------

### Basic YAML Configuration Example

Source: https://docs.groupez.dev/zmenu/configurations/informations

Shows the basic YAML structure used in zMenu configuration files, including comments, string, number, boolean values, and nested sections. Indentation uses 2 spaces and colons require a space after the key.

```yaml
# This is a comment  
inventory-name: "My Inventory"    # String value  
size: 54                          # Number value  
enabled: true                     # Boolean value  
  
items:                            # Start of a section  
  my-button:                      # Button name (key)  
    slot: 0                       # Property of my-button  
    item:                         # Nested section  
      material: DIAMOND  
      name: "&bDiamond"  

```

--------------------------------

### Inventory Usage Example (one button shown)

Source: https://docs.groupez.dev/zmenu/configurations/patterns

Shows how to use the playtime_reward pattern in an inventory. Defines a button with pattern fileName, slot, level, hour, color, head, rewards list, and commands list.

```yaml
items:  
  btn-10:  
    pattern:  
      fileName: "playtime_reward"  
      slot: 10  
      level: 1  
      hour: 1  
      color: "#7f7f7f"  
      head: "eyJ0ZXh0dXJlcyI6..."  
      rewards:  
        - '&f50$'  
        - '&fx4 Iron Ingots'  
      commands:  
        - 'eco give %player% 50'  
        - 'give %player% iron_ingot 4'  

```

--------------------------------

### /zm open <inventory> <player> <args...>

Source: https://docs.groupez.dev/zmenu/configurations/commands-permissions

Opens an inventory with arguments. Requires the zmenu.open permission.

```APIDOC
## /zm open <inventory> <player> <args...>

### Description
Open inventory with arguments

### Method
COMMAND

### Endpoint
/zm open <inventory> <player> <args...>

### Parameters
#### Path Parameters
- **inventory** (string) - Required - The name of the inventory to open
- **player** (string) - Required - The player to open the inventory for
- **args...** (string) - Required - Additional arguments for the inventory

### Permission
zmenu.open

### Response
Inventory opened with arguments
```

--------------------------------

### LuckPerms click requirement example

Source: https://docs.groupez.dev/zmenu/supported-plugins

Example configuration for a click requirement that checks if the player has the 'vip' LuckPerms group. If not, it sends a denial message.

```yaml
click-requirement:  
  vip-check:  
    clicks:  
      - ALL  
    requirements:  
      - type: luckperm  
        group: vip  
        deny:  
          - type: message  
            messages:  
             - "&cYou need VIP rank to use this!"  

```

--------------------------------

### Styled Home Button example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/types/home

A HOME button using a PLAYER_HEAD with a custom texture URL, a styled name, lore, and a chime sound. Demonstrates customization options.

```yaml
items:  
  home:  
    type: HOME  
    slot: 49  
    item:  
      material: PLAYER_HEAD  
      url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYzVhMzFjNjQ1MzNlNTRhZmFjZjA0YzNhMTY3YzM4YjBhYjIzMjI3NjdmYjE2MWVmMTU5MjI5YTI4ZmJiN2EifX0="  
      name: "&6&l⌂ Home"  
      lore:  
        - "&7Return to the main menu"  
        - ""  
        - "&e▸ Click to go home"  
    sound: BLOCK_NOTE_BLOCK_CHIME  

```

--------------------------------

### Styled Main Menu Button example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/types/mainmenu

A MAIN_MENU button using a custom player head texture and a chime sound.

```yaml
items:  
  main-menu:  
    type: MAIN_MENU  
    slot: 49  
    item:  
      material: PLAYER_HEAD  
      url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYzVhMzFjNjQ1MzNlNTRhZmFjZjA0YzNhMTY3YzM4YjBhYjIzMjI3NjdmYjE2MWVmMTU5MjI5YTI4ZmJiN2EifX0="  
      name: "&6&l⌂ Main Menu"  
      lore:  
        - "&7Go to the server's main menu"  
        - ""  
        - "&e▸ Click to open"  
    sound: BLOCK_NOTE_BLOCK_CHIME  

```

--------------------------------

### send-toast alias example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/actions

Alias for the toast action using 'send toast' as the type. Shows a minimal example with material, message, and toast-type.

```yaml
- type: "send toast"  
  material: DIAMOND  
  message: "&aAchievement Unlocked!"  
  toast-type: CHALLENGE   # TASK, GOAL, or CHALLENGE (default: CHALLENGE)  

```

--------------------------------

### player-head YAML example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/button

YAML configuration for a button that displays the current player's head.

```yaml
items:  
  profile:  
    slot: 0  
    player-head: "%player%"  
    item:  
      material: PLAYER_HEAD  
      name: "&a&l%player%"  

```

--------------------------------

### bedrock-dynamic-button example

Source: https://docs.groupez.dev/zmenu/configurations/bedrock

Repeats a clickable button for simple forms. Each button has its own actions. The example creates five buttons that display their unique index when clicked.

```yaml
type: simple  
name: "&6Dynamic Bedrock Simple Example"  
content: "&7Each button shows its unique index."  
  
buttons:  
  dynamic_buttons:  
    type: bedrock-dynamic-button  
    start: 1  
    end: 5  
    button:  
      type: bedrock_modal_button  
      text: "&bClick Me! &e(Button #%index%)"  
      actions:  
        - type: MESSAGE  
          messages:  
            - "&aYou clicked dynamic button &6#%index%&a!"  

```

--------------------------------

### Basic custom command structure

Source: https://docs.groupez.dev/zmenu/configurations/custom-commands

Defines a custom command 'shop' that opens the 'shop_menu' inventory. This is the minimal configuration required.

```yaml
commands:  
  shop:  
    command: shop  
    inventory: shop_menu  

```

--------------------------------

### /zm create <file name> <inventory size> <inventory name>

Source: https://docs.groupez.dev/zmenu/configurations/commands-permissions

Creates a new inventory file. Requires the zmenu.create permission.

```APIDOC
## /zm create <file name> <inventory size> <inventory name>

### Description
Create a new inventory file

### Method
COMMAND

### Endpoint
/zm create <file name> <inventory size> <inventory name>

### Parameters
#### Path Parameters
- **file name** (string) - Required - The name of the inventory file
- **inventory size** (integer) - Required - The size of the inventory
- **inventory name** (string) - Required - The display name of the inventory

### Permission
zmenu.create

### Response
New inventory file created
```

--------------------------------

### buttons property example

Source: https://docs.groupez.dev/zmenu/configurations/buttons/types/switch

Example of the 'buttons' property, which is required and maps placeholder values to button configurations. Each key is a placeholder result, and the value is the button config to display.

```yaml
buttons:  
  "value1":  
    item:  
      material: DIAMOND  
    actions:  
      - type: message  
        messages: ["Value is 1"]  
  "value2":  
    item:  
      material: EMERALD  
    actions:  
      - type: message  
        messages: ["Value is 2"]  

```

--------------------------------

### Convert DeluxeMenus menus with /zm convert deluxemenus

Source: https://docs.groupez.dev/zmenu/convert-deluxemenus

Run this command to convert all DeluxeMenus menus from plugins/DeluxeMenus/gui_menus/ into zMenu inventories. The alias /zm convert dm also works.

```text
/zm convert deluxemenus  
```

--------------------------------

### on-click mechanic example

Source: https://docs.groupez.dev/zmenu/configurations/items/mechanics

Example of the on-click mechanic on a magic wand item, with a cooldown, click restrictions, permission requirements, and actions that send a message and run a player command.

```yaml
magic-wand:  
  name: "&dMagic Wand"  
  material: BLAZE_ROD  
  mechanics:  
    on-click:  
      cooldown: 3  
      cancel-event: true  
      click-target: both  
      click-types:  
        - RIGHT  
        - SHIFT_RIGHT  
      click-requirements:  
        1:  
          requirements:  
            - type: permission  
              permission: "server.wand"  
              deny:  
                - type: message  
                  messages:  
                    - "&cYou can't use this wand."  
      actions:  
        - type: message  
          messages:  
            - "&dPoof! ✨"  
        - type: player-command  
          commands:  
            - "spawn"  

```

--------------------------------

### Data action example

Source: https://docs.groupez.dev/zmenu/configurations/player-data

Example of the data action with action SET, key 'coins', value '100', and math enabled. The action can be SET, ADD, SUBTRACT, MULTIPLY, DIVIDE, or REMOVE.

```yaml
actions:  
  - type: data  
    action: SET      # SET, ADD, SUBTRACT, MULTIPLY, DIVIDE, REMOVE  
    key: "coins"  
    value: "100"  
    math: true       # Enable math expressions  

```

--------------------------------

### Example usage of target player placeholder

Source: https://docs.groupez.dev/zmenu/configurations/inventories/inventory

Shows how to use the target-player-name-placeholder in an inventory with a player head item displaying the target's name.

```yaml
name: "&6Profile of %target%"  
target-player-name-placeholder: "%target%"  
  
items:  
  info:  
    slot: 13  
    item:  
      material: PLAYER_HEAD  
      name: "&e%target%"  
      lore:  
        - "&7Viewing player profile"  
```

--------------------------------

### Nested Placeholder Example

Source: https://docs.groupez.dev/zmenu/configurations/placeholders

Example of using a placeholder inside another placeholder, specifically using player data in a math expression. The placeholder %zmenu_math_{zmenu_player_value_coins}*2% calculates double coins.

```yaml
# Using player data in math  
lore:  
  - "&7Double coins: %zmenu_math_{zmenu_player_value_coins}*2%"  

```

--------------------------------

### Create and Use InventoryEngine

Source: https://docs.groupez.dev/zmenu/development/api-inventory

Creates an InventoryEngine instance for a player and opens the inventory, optionally at a specific page.

```java
manager.getInventory("shop").ifPresent(inv -> {  
    // Create an engine instance for this player  
    InventoryEngine engine = manager.createInventoryEngine(player, inv);  
  
    // Open with the engine  
    engine.open();  
  
    // Or open at specific page  
    engine.open(2);  
});  
```

--------------------------------

### bedrock-dynamic-input-button example

Source: https://docs.groupez.dev/zmenu/configurations/bedrock

Repeats an input element for custom forms. Each generated input's value is available as %<button-name>_<index>%. The example creates two text inputs and displays their values in messages.

```yaml
type: custom  
name: "&6Dynamic Bedrock Example"  
  
buttons:  
  # If the player types "Value A" in the first box, %dynamic_input_1% will be "Value A"  
  dynamic_input:  
    type: bedrock-dynamic-input-button  
    start: 1  
    end: 2  
    input:  
      type: bedrock_text  
      text: "&6Enter your name #%index%:"  
  
actions:  
  1:  
    success:  
      - type: message  
        messages:  
          - "&eInput 1: &f%dynamic_input_1%"  
          - "&eInput 2: &f%dynamic_input_2%"  

```

--------------------------------

### Download PlaceholderAPI expansion

Source: https://docs.groupez.dev/zmenu/installation

Command to download a required PlaceholderAPI expansion. Replace <expansion> with the actual expansion name.

```bash
/papi ecloud download <expansion>
```

--------------------------------

### bedrock action - with arguments

Source: https://docs.groupez.dev/zmenu/configurations/buttons/actions

Opens a Bedrock form and passes arguments to it.

```yaml
- type: bedrock  
  bedrock: "feedback-form"  
  arguments:  
    - "arg1"  
    - "arg2"  

```

--------------------------------

### Item Inspection Placeholders Example

Source: https://docs.groupez.dev/zmenu/configurations/placeholders

YAML configuration showing how to use item inspection placeholders in lore and click requirements. The example checks if a drag slot contains a diamond and denies the action with a message if not.

```yaml
lore:  
  - "&7Slot 13 material: %zmenu_item_inventory:13_material%"  
  - "&7Helmet: %zmenu_item_armor:helmet_material%"  
  - "&7Player slot 0 amount: %zmenu_item_player:0_amount%"  
  
# Check if a drag slot has the right item  
click-requirement:  
  check:  
    clicks:  
      - ALL  
    requirements:  
      - type: placeholder  
        placeholder: "%zmenu_item_inventory:13_material%"  
        action: EQUALS_STRING  
        value: "DIAMOND"  
        deny:  
          - type: message  
            messages:  
              - "&cPlace a diamond in the slot!"  

```
Tokens:
Raw