# \ud83d\udc31 MiaoMenu \u2014 The menu plugin that actually gets it right<\/p>\n
> *Do what suits you best, make the difficult simple.* That’s the idea.<\/p>\n
\n
\n
\n
\n<\/p>\n
—<\/p>\n
## Sound familiar?<\/p>\n
| Frustrating stuff | Other plugins | MiaoMenu |
\n|—|—|—|
\n| Bedrock players can’t see menus | Need a separate plugin | Auto-detected, native support |
\n| Every config change means a reload | `\/reload` over and over | Save the file, you’re done \u2014 0.5-second hot-reload |
\n| Cross-server menus are a pain | Complex setups required | BungeeCord \/ Velocity built in |
\n| Players lose the menu item | No protection | NBT-tagged clock, survives death |
\n| Folia breaks everything | Console spam | Runs natively on Folia |<\/p>\n
—<\/p>\n
## What it does<\/p>\n
### \ud83c\udfaf One config, both editions<\/p>\n
MiaoMenu checks whether a player is on Java or Bedrock and serves the right UI automatically:<\/p>\n
– **Java players** get the classic chest inventory (1\u20136 rows, up to 54 slots)
\n– **Bedrock players** get a native form UI designed for touch screens\uff08need Floodgate\uff09<\/p>\n
You write the menu logic once. The plugin handles the rest.<\/p>\n
\n<\/p>\n
### \u26a1 Hot-reload that actually works<\/p>\n
Powered by Java’s `WatchService` with a 0.5-second debounce. Edit a YAML file, hit save \u2014 the changes go live immediately. No commands needed.<\/p>\n
(There’s still a `\/dgm reload` command if you prefer doing things manually.
\nMoreover, tested with over 10 reloads, no memory leaks detected.)<\/p>\n
### \ud83d\udd70\ufe0f The Time Mirror (menu clock)<\/p>\n
Every player receives a clock item tagged with NBT data:<\/p>\n
– Checked on login \u2014 if it’s missing from their inventory, it gets replaced automatically. No duplicates.
\n– Protected on death \u2014 the clock never drops, and it reappears after respawn.
\n– Right-click to open the default menu instantly.
\n– Uniquely identified via NBT, so it won’t clash with other items.<\/p>\n
### \ud83d\udd17 Cross-server teleportation<\/p>\n
Built-in support for **BungeeCord** and **Velocity** proxy setups. The plugin detects which one you’re running and configures itself.<\/p>\n
“`yaml
\n# config.yml \u2014 one line to enable
\nsettings:
\n velocity-network: true
\n“`<\/p>\n
Pair it with a server-selector menu and players can hop between servers in one click:<\/p>\n
“`yaml
\n# server-selector.yml
\nsurvival:
\n slot: 12
\n material: DIAMOND_SWORD
\n display_name: “&c&lSurvival”
\n left_click_commands:
\n – “[player] server survival”
\n – “[message] &aConnecting to survival…”
\n – “[close]”
\n“`<\/p>\n
### \ud83c\udfa8 Flexible menu configuration<\/p>\n
**Java Edition** \u2014 straightforward YAML:<\/p>\n
“`yaml
\nmenu_title: “&6&lMain Menu &7| &fServer Name”
\nrows: 6<\/p>\n
items:
\n server_info:
\n slot: 10
\n material: KNOWLEDGE_BOOK
\n display_name: “&e&lServer Info”
\n lore:
\n – “&7Click to view server information”
\n – “&fOnline: &a%server_online%&f\/&a%server_max_players%”
\n left_click_commands:
\n – “[message] &6=== Server Info ===”
\n – “[player] list”
\n – “[close]”
\n“`<\/p>\n
**Bedrock Edition** \u2014 native forms:<\/p>\n
“`yaml
\nmenu:
\n title: “\u00a76\u00a7lMain Menu”
\n items:
\n – text: “\u00a7e\u00a7lServer Infon\u00a77Click for details”
\n icon: “textures\/items\/book_enchanted”
\n icon_type: “path”
\n command: “dgeysermenu open info”
\n execute_as: “player”
\n“`<\/p>\n
### \ud83d\udee0 Action system<\/p>\n
Five built-in action types cover the usual interactions:<\/p>\n
| Action | Syntax | What it does |
\n|—|—|—|
\n| Run as player | `[player] spawn` | The player executes the command |
\n| Run as console | `[cmd] give %player% diamond 1` | Console executes the command |
\n| Send a message | `[message] &aWelcome back!` | Sends chat text to the player |
\n| Close the menu | `[close]` | Closes the current menu |
\n| Open another menu | `[menu] shop` | Opens a different menu (nesting supported) |<\/p>\n
You can bind separate actions to left-click and right-click:<\/p>\n
“`yaml
\nleft_click_commands:
\n – “[player] spawn”
\nright_click_commands:
\n – “[close]”
\n“`<\/p>\n
### \ud83e\udde9 Plugin integrations<\/p>\n
| Plugin | What you get |
\n|—|—|
\n| **PlaceholderAPI** | Full PAPI variable support \u2014 player stats, economy, online count, whatever you need |
\n| **Floodgate \/ Geyser** | Automatic Bedrock detection, no extra setup |
\n| **CraftEngine** | Use custom items as menu icons |
\n| **bStats** | Anonymous usage metrics, bundled in |<\/p>\n
### \ud83c\udfb5 Menu sounds<\/p>\n
Pick any Minecraft sound to play when a menu opens:<\/p>\n
“`yaml
\nsettings:
\n open-menu-sound:
\n enabled: true
\n sound: “entity.experience_orb.pickup”
\n volume: 1.0
\n pitch: 1.0
\n“`<\/p>\n
### \ud83c\udf43 Lightweight & Folia-ready<\/p>\n
– Minimal footprint \u2014 core features only, no bloat.
\n– Detects Folia at startup and switches to the correct scheduler automatically.
\n– Built on Paper 1.21.8+ API.<\/p>\n
—<\/p>\n
## Getting started<\/p>\n
### Installation<\/p>\n
1. Drop the JAR into your server’s `plugins` folder.
\n2. Restart the server.
\n3. Open `plugins\/MiaoMenu\/` \u2014 sample menus are generated automatically.
\n4. Edit configs to match your server; changes apply on save.<\/p>\n
### Commands<\/p>\n
| Command | Description | Permission |
\n|—|—|—|
\n| `\/dgm open <\/p>\n