Getting Started
Introduction to zMenu - The most powerful inventory plugin for Minecraft
zMenu is the most powerful and flexible inventory (GUI) plugin for Minecraft servers. It allows you to create beautiful, interactive menus with an extensive configuration system that gives you complete control over every aspect of your inventories.
What is zMenu?
zMenu is a premium-quality inventory plugin that enables server administrators to create custom GUIs (Graphical User Interfaces) for their Minecraft servers. Whether you need a simple server selector, a complex shop system, or an interactive quest menu, zMenu provides all the tools you need.
Coming from DeluxeMenus? Switch in one command
You don't have to rewrite your menus. zMenu converts your DeluxeMenus menus automatically: items, slots, click commands, requirements and open commands are translated into zMenu inventories in seconds.
/zm convert deluxemenusEverything that cannot be converted exactly is listed at the top of each converted file, and your DeluxeMenus files are never modified. Read the migration guide →
Edit live with the hot reload
Save a file, the menu is updated in game. No /zm reload, no restart. With the hot reload enabled, zMenu watches your inventories/ folder and reloads, loads or unloads inventories as soon as their files change. Players with the menu open see the new version instantly, on the same page, and a file with an error never replaces the working version.
# config.yml
hot-reload:
enable: trueKey Features
Migration & Workflow
- DeluxeMenus converter: convert all your DeluxeMenus menus with
/zm convert deluxemenus - Hot reload: changes to your inventory files are applied instantly, without any command
- Online editor: design menus visually on minecraft-inventory-builder.com
Highly Customizable Inventories
- Create inventories of any size (9 to 54 slots)
- Multi-page support with automatic pagination
- Custom titles with placeholder support
- Fill items for empty slots
- Matrix-based layout system for easy design
Powerful Button System
- 9 built-in button types: NONE, INVENTORY, BACK, NEXT, PREVIOUS, HOME, JUMP, MAIN_MENU, SWITCH
- Custom click actions for each mouse button
- View and click requirements
- Player head support with custom textures
- Dynamic item updates
Extensive Action System
- 28+ action types including messages, sounds, commands, teleportation, and more
- Execute actions as player, console, or with OP permissions
- Chain multiple actions together
- Conditional actions with requirements
Advanced Features
- Pattern System: Create reusable button templates
- Player Data: Store and retrieve player-specific data
- Global Placeholders: Define values used across all inventories
- PlaceholderAPI Support: Full integration with PAPI
- MiniMessage Support: Modern text formatting for Paper servers
- Anti-Dupe System: Built-in protection against item duplication exploits
- Database Support: MySQL, MariaDB, and SQLite for data persistence
Developer Friendly
- Clean, well-documented API
- Custom button type registration
- Custom action type registration
- Event system for inventory interactions
Why Choose zMenu?
| Feature | zMenu | Other Plugins |
|---|---|---|
| Import DeluxeMenus menus | One command | Rewrite by hand |
| Hot reload | Automatic, no command | Manual reload |
| Button Types | 9+ built-in | Limited |
| Action Types | 28+ | Basic |
| Multi-page Support | Native | Often requires workarounds |
| Pattern System | Yes | No |
| Player Data Storage | Yes | Rarely |
| MiniMessage Support | Yes | Rarely |
| Database Support | MySQL/MariaDB/SQLite | Usually file-based only |
| API Quality | Comprehensive | Often minimal |
| Active Development | Yes | Varies |
| Free | Yes | Often paid |
How It Works
zMenu uses YAML configuration files to define your inventories. Here's a simplified overview:
- Inventories are defined in the
inventories/folder - Each inventory contains buttons (items that players can interact with)
- Buttons can have actions that execute when clicked
- Requirements control who can see or click buttons
- Patterns allow you to reuse button configurations
Simple Example
# inventories/my_menu.yml
name: "&6My First Menu"
size: 27
items:
welcome-button:
slot: 13
item:
material: DIAMOND
name: "&bWelcome!"
lore:
- "&7Click me to receive a message"
actions:
- type: message
messages:
- "&aHello, %player%!"
- "&7Thanks for using zMenu!"This creates a simple 27-slot inventory with a diamond in the center that sends a message when clicked.
Supported Minecraft Versions
zMenu supports Minecraft versions 1.20.6 and newer and works with:
- Paper (required)
- Purpur
- Pufferfish
- Folia
Paper Required
As of version 1.1.1.6, zMenu is Paper-only — you must use Paper or a Paper fork (Purpur, Pufferfish) or Folia. On Spigot the plugin still loads, but only to print a warning explaining that Paper is required: no zMenu feature works there.
Next Steps
Ready to get started? Follow these steps:
- Install zMenu on your server
- Using DeluxeMenus? Convert your menus in one command
- Enable the hot reload to see your changes instantly
- Learn about the configuration system
- Create your first inventory
- Explore button types and actions
Getting Help
- Discord: Join our Discord server for support
- Modrinth: Download from Modrinth
- GitHub: Report issues on GitHub
- Dev Builds: Get development versions in the
#buildschannel on Discord