---
title: "zMenu Plugin Setup: Custom GUI Menus in YAML | ZCS"
description: "Set up the zMenu plugin to build custom GUI menus: install, YAML menu example, commands, placeholders, hooks and common errors."
url: "https://www.zcraftstudios.com/blog/zmenu-plugin-setup-guide"
updated: "2026-10-29T01:53:09.929688+00:00"
source: "ZCraft Studios"
---

> Site index for AI agents: https://www.zcraftstudios.com/llms.txt (full reference: https://www.zcraftstudios.com/llms-full.txt). Every page is available as Markdown by adding `.md` to its URL or sending `Accept: text/markdown`.

1. [Home](https://www.zcraftstudios.com/)
2. [Blog](https://www.zcraftstudios.com/blog)
3. zMenu Plugin Setup: Custom GUI Menus in YAML

[ All posts](https://www.zcraftstudios.com/blog)

# zMenu Plugin Setup: Custom GUI Menus in YAML

ZCraft StudiosOct 29, 2026

Set up the zMenu plugin to build custom GUI menus: install, YAML menu example, commands, placeholders, hooks and common errors.

## In this guide

- [What zMenu does](#what-zmenu-does)
- [Install zMenu](#install-zmenu)
- [Create your first menu](#create-your-first-menu)
- [Useful commands](#useful-commands)
- [Link a menu to a command](#link-a-menu-to-a-command)
- [Use cases for a menu plugin](#use-cases-for-a-menu-plugin)
- [Design menus that work](#design-menus-that-work)
- [Common problems](#common-problems)
- [zMenu vs other menu plugins](#zmenu-vs-other-menu-plugins)
- [Frequently asked questions](#frequently-asked-questions)
- [Related reading](#related-reading)

## zMenu Plugin Setup: Custom GUI Menus in YAML

**Quick answer:** zMenu is a free, open-source plugin that lets you build custom inventory GUIs in YAML, with no coding. Put the jar in `plugins/`, restart, create a menu file in `plugins/zMenu/inventories/`, and apply changes with `/zm reload`. It supports PlaceholderAPI, MiniMessage, multi-page menus, command arguments and hooks into many plugins.

_Details come from the project's documentation, GitHub page and resource listings, last checked October 2026\. Check the plugin page for the Minecraft versions your build supports._

## What zMenu does

| Feature             | Details                                                                              |
| ------------------- | ------------------------------------------------------------------------------------ |
| Custom menus        | Unlimited GUIs, each in its own YAML file                                            |
| Commands            | Link menus to custom commands, with arguments                                        |
| Pages               | Several pages in one inventory                                                       |
| Buttons and actions | A large set of actions, with conditions and click handlers                           |
| Placeholders        | PlaceholderAPI support. See [PlaceholderAPI Setup](https://www.zcraftstudios.com/blog/placeholderapi-setup-guide) |
| Text                | Adventure MiniMessage support                                                        |
| Platforms           | Spigot, Paper and Folia, with Bedrock support listed                                 |
| Hooks               | ItemsAdder, Oraxen, Nexo, LuckPerms, Vault, MythicMobs and others                    |
| Migration           | Reports say DeluxeMenus configurations can be used or converted                      |

## Install zMenu

1. Download zMenu from Modrinth, Hangar or SpigotMC, and check the supported Minecraft versions.
2. Stop the server, copy the jar into `plugins/` and start it. See [How to Add Plugins to a Minecraft Server](https://www.zcraftstudios.com/blog/how-to-add-plugins-to-minecraft-server).
3. Install optional plugins you want hooks for, such as Vault or PlaceholderAPI.
4. Check the console for errors. See [Plugin Not Loading?](https://www.zcraftstudios.com/blog/minecraft-plugin-not-loading-fix).

## Create your first menu

Menus live in `plugins/zMenu/inventories/`, one inventory per file, and you can sort files into folders. A minimal example follows the shape in the project README:

```
size: 27
name: "&6My Menu"

items:
  example:
    slot: 13
    item:
      material: DIAMOND
      name: "&bClick me!"
```

The exact keys evolve between versions, so compare with the example files generated in your folder and the [zMenu documentation](https://docs.zmenu.dev). After saving, reload:

```
/zm reload
```

## Useful commands

| Command         | Purpose                                                          |
| --------------- | ---------------------------------------------------------------- |
| /zm reload      | Reload menus and configuration                                   |
| /zm inventories | List or open inventories, and link menus from the online builder |
| /zm save        | Turn an item you hold into configuration                         |

Run `/zm` for the full list on your version.

## Link a menu to a command

Menus can open from a custom command you define, which lets players run something like `/menu` or `/shop`. Check the documentation for how to declare the command in the inventory file or the commands config in your version.

## Use cases for a menu plugin

| Menu                     | Why                                                                                                  |
| ------------------------ | ---------------------------------------------------------------------------------------------------- |
| Server selector or lobby | Compass or NPC opens a menu. See [Hub and Lobby Design](https://www.zcraftstudios.com/blog/building-a-minecraft-hub-lobby-server) |
| Shops                    | Sell and buy menus. See [ShopGUIPlus Setup](https://www.zcraftstudios.com/blog/shopguiplus-gui-shop-setup)                        |
| Ranks and perks          | Display ranks and unlocks. See [LuckPerms Setup Guide](https://www.zcraftstudios.com/blog/luckperms-ranks-setup-guide)            |
| Rules and onboarding     | Guides for new players. See [New Player Onboarding](https://www.zcraftstudios.com/blog/new-player-onboarding-tutorial-setup)      |
| Cosmetics                | Tags and effects. See [EternalTags Plugin Setup](https://www.zcraftstudios.com/blog/eternaltags-plugin-setup-guide)               |
| Warps                    | Teleport menus                                                                                       |

## Design menus that work

1. Keep menus small and readable.
2. Use clear item names and lore, and consistent colors.
3. Place the most important button in the center.
4. Add a back or close button on every page.
5. Test on Java and Bedrock if you allow both. See [Bedrock Crossplay Setup](https://www.zcraftstudios.com/blog/geyser-floodgate-bedrock-crossplay-setup).
6. Avoid giving players items that can be moved out of the menu. Use menu buttons, not real item slots.

## Common problems

| Problem                     | Fix                                                                                           |
| --------------------------- | --------------------------------------------------------------------------------------------- |
| Menu does not open          | Check the file loaded, run /zm reload, and read the console                                   |
| Items look wrong            | Check the material name matches your Minecraft version                                        |
| Placeholders show raw text  | Install PlaceholderAPI and the needed expansion                                               |
| Custom item missing         | The plugin providing it, such as ItemsAdder, must load first                                  |
| YAML error                  | Check indentation. See [Plugin Config Review](https://www.zcraftstudios.com/blog/minecraft-plugin-config-review-checklist) |
| Animated titles do not work | The feature needs PacketEvents, according to the project                                      |

## zMenu vs other menu plugins

Several menu plugins exist, including DeluxeMenus. Compare supported versions, how often each is updated, hooks, documentation and how the plugins handle your existing menu files before switching. Test on a staging copy. See [Staging Environment Guide](https://www.zcraftstudios.com/blog/minecraft-server-staging-environment-guide).

## Frequently asked questions

**Is zMenu free?** The plugin is listed as free and open source.

**Does zMenu work on Paper and Folia?** Yes, according to its listings, but check the version range.

**Can I use PlaceholderAPI in zMenu menus?** Yes.

**Can I convert DeluxeMenus menus?** The project says DeluxeMenus configurations are supported, and a conversion plugin exists. Test the result.

**Does zMenu work with Bedrock?** Bedrock support is listed. Test with a Bedrock account.

## Related reading

- [Best Minecraft Server Plugins by Category](https://www.zcraftstudios.com/blog/best-minecraft-plugins-by-category)
- [Citizens NPC Setup](https://www.zcraftstudios.com/blog/citizens-npc-setup-guide)
- [Free vs Premium Minecraft Configs](https://www.zcraftstudios.com/blog/free-vs-premium-minecraft-configs)

## Continue reading

- [EliteSpawner Custom Spawner Types: Loot Tables and Prices](https://www.zcraftstudios.com/blog/elitespawner-custom-spawner-types-loot-tables)
- [EternalTags Plugin Setup: Chat Tags, Menus, Permissions](https://www.zcraftstudios.com/blog/eternaltags-plugin-setup-guide)
- [Minecraft Plugin Config Review: Avoid YAML Mistakes](https://www.zcraftstudios.com/blog/minecraft-plugin-config-review-checklist)
- [Setting Up Slimefun for Custom Tech and Magic](https://www.zcraftstudios.com/blog/slimefun-custom-tech-magic-setup)

[ Previous guide level-type in server.properties: Minecraft World Types](https://www.zcraftstudios.com/blog/minecraft-level-type-world-types-server)[ Next guide How to Make a Modded Minecraft Server: Fabric and NeoForge](https://www.zcraftstudios.com/blog/how-to-make-a-modded-minecraft-server)

<script type="application/ld+json">{"@context":"https://schema.org","@type":"Organization","@id":"https://www.zcraftstudios.com/#organization","name":"ZCraft Studios","alternateName":["ZCS","ZCraft","ZCraftStudios"],"logo":{"@type":"ImageObject","url":"https://www.zcraftstudios.com/favicon-192.png","width":192,"height":192},"image":{"@type":"ImageObject","url":"https://www.zcraftstudios.com/favicon-192.png","width":192,"height":192},"url":"https://www.zcraftstudios.com","description":"ZCraft Studios (ZCS) creates Minecraft plugins, server configs and tools. Browse resources, compatibility details and setup guides.","email":"Support@zcraftstudios.com","slogan":"Minecraft resources, configurations and custom server development.","knowsAbout":["Minecraft plugins","Minecraft server configuration","Java plugin development","Minecraft server optimization"],"sameAs":["https://dsc.gg/zcraftstudios","https://x.com/ZCraftNetwork","https://www.youtube.com/@zcraft_studios","https://www.instagram.com/ZCraftStudios"],"contactPoint":[{"@type":"ContactPoint","contactType":"customer support","email":"Support@zcraftstudios.com","availableLanguage":["English"],"areaServed":"Worldwide"}]}</script>
<script type="application/ld+json">{"@context":"https://schema.org","@type":"WebSite","@id":"https://www.zcraftstudios.com/#website","url":"https://www.zcraftstudios.com","name":"ZCraft Studios","alternateName":["ZCS","ZCraft"],"description":"ZCraft Studios (ZCS) creates Minecraft plugins, server configs and tools. Browse resources, compatibility details and setup guides.","inLanguage":"en","publisher":{"@type":"Organization","@id":"https://www.zcraftstudios.com/#organization","name":"ZCraft Studios","url":"https://www.zcraftstudios.com"}}</script>
<script type="application/ld+json">{"@context":"https://schema.org","@type":"BlogPosting","@id":"https://www.zcraftstudios.com/blog/zmenu-plugin-setup-guide#article","headline":"zMenu Plugin Setup: Custom GUI Menus in YAML","url":"https://www.zcraftstudios.com/blog/zmenu-plugin-setup-guide","mainEntityOfPage":"https://www.zcraftstudios.com/blog/zmenu-plugin-setup-guide","isPartOf":{"@type":"WebSite","@id":"https://www.zcraftstudios.com/#website","name":"ZCraft Studios","url":"https://www.zcraftstudios.com"},"speakable":{"@type":"SpeakableSpecification","cssSelector":["h1","main"]},"description":"Set up the zMenu plugin to build custom GUI menus: install, YAML menu example, commands, placeholders, hooks and common errors.","datePublished":"2026-10-29T01:53:09.929688+00:00","dateModified":"2026-10-29T01:53:09.929688+00:00","author":{"@type":"Organization","@id":"https://www.zcraftstudios.com/#organization","name":"ZCraft Studios","url":"https://www.zcraftstudios.com/about"},"publisher":{"@type":"Organization","@id":"https://www.zcraftstudios.com/#organization","name":"ZCraft Studios","url":"https://www.zcraftstudios.com","logo":{"@type":"ImageObject","url":"https://www.zcraftstudios.com/favicon-192.png","width":192,"height":192}},"inLanguage":"en","image":"https://www.zcraftstudios.com/api/og/blog/zmenu-plugin-setup-guide?v=1ust0xz"}</script>
<script type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https://www.zcraftstudios.com/"},{"@type":"ListItem","position":2,"name":"Blog","item":"https://www.zcraftstudios.com/blog"},{"@type":"ListItem","position":3,"name":"zMenu Plugin Setup: Custom GUI Menus in YAML","item":"https://www.zcraftstudios.com/blog/zmenu-plugin-setup-guide"}]}</script>