Skip to content

Repository files navigation

zMenu

ModrinthDiscordJavaMinecraft

zMenu is a powerful Minecraft plugin for creating custom inventory GUIs through YAML configuration files. No coding required for server admins, while developers get a complete API for integration.

showcasepunishoptionnal argshoptitle animation

Features

  • YAML Configuration - Create menus without coding
  • 30+ Item Components - Full support for Minecraft 1.20.5+ item system
  • Animated Titles - Dynamic inventory titles (requires PacketEvents)
  • Pattern System - Reusable layouts and button templates
  • Actions & Requirements - 40+ actions, conditional logic, click handlers
  • PlaceholderAPI - Full placeholder support with local overrides
  • Multi-platform - Spigot, Paper, and Folia support
  • 22+ Plugin Hooks - ItemsAdder, Oraxen, LuckPerms, Vault, MythicMobs, and more
  • Bedrock - Bedrock support

Links

ResourceLink
DownloadModrinth
Documentationdocs.groupez.dev
JavaDocsAPI Reference
Discorddiscord.groupez.dev
Inventory Builderminecraft-inventory-builder.com

Quick Start

  1. Download zMenu from Modrinth
  2. Place the JAR in your plugins/ folder
  3. Restart your server
  4. Edit files in plugins/zMenu/inventories/
  5. Use /zm reload to apply changes

Example Inventory

size: 27name: "&6My Menu"items:
example:
slot: 13item:
material: DIAMONDname: "&bClick me!"lore:
- "&7This is an example button"click_requirement:
left_click:
clicks: [LEFT, SHIFT_LEFT]success:
- type: messagemessages:
- "&aYou clicked the button!"

API Usage

Maven

<repository>
<id>groupez</id>
<url>https://repo.groupez.dev/releases</url>
</repository>
<dependency>
<groupId>fr.maxlego08.menu</groupId>
<artifactId>zmenu-api</artifactId>
<version>1.1.1.7</version>
<scope>provided</scope>
</dependency>

Gradle

repositories {
maven("https://repo.groupez.dev/releases")
}
dependencies {
compileOnly("fr.maxlego08.menu:zmenu-api:1.1.1.7")
}

Opening an inventory

InventoryManagermanager = plugin.getServer().getServicesManager()
.getRegistration(InventoryManager.class).getProvider();
manager.openInventory(player, "zmenu:example");

Supported Plugins

Click to expand
  • ItemsAdder
  • Oraxen
  • Nexo
  • Nova
  • SlimeFun
  • ExecutableItems
  • ExecutableBlocks
  • HeadDatabase
  • zHead
  • zItems
  • MythicMobs
  • LuckPerms
  • Vault
  • PlaceholderAPI
  • PacketEvents
  • Jobs
  • Shopkeepers
  • MagicCosmetics
  • HMCCosmetics
  • BreweryX
  • CraftEngine
  • Eco

Sponsors

License

This project is licensed under the MIT License.

About

A plugin that will allow the creation of menu for minecraft, has a complete API for developers

Topics

Resources

Stars

87 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages