Getting started
Getting started
This guide takes you from installation to a working Dialog Master menu. Complete the steps in order, then continue to the core concepts when you are ready to customize the experience.
Before you begin
You need a compatible Minecraft server and permission to place files in its plugins/ directory. Optional integrations provide additional features:
| Dependency | When it is needed |
|---|---|
| PlaceholderAPI | Placeholder replacement in titles, bodies, and requirement checks. |
| Vault | Economy integration and currency leaderboards. |
| EssentialsX | The essentials:homes dynamic-list provider. |
Install Dialog Master
1. Download the plugin
Download the latest DialogMaster.jar release.
2. Install the JAR
Place DialogMaster.jar in the server's plugins/ directory.
3. Start the server
Restart the server and confirm that Dialog Master enables without errors in the console.
4. Open the generated folder
Navigate to plugins/DialogMaster/. The plugin stores configuration and menu files there.
Create your first menu
Create plugins/DialogMaster/menus/welcome.yml:
welcome:
title: "<gold>Welcome"
type: notice
body:
- type: plain-message
content: "<gray>Welcome to the server!"
ok-button:
label: "<green>Continue"
width: 100
action: close
Reload the plugin with /ydm reload, then open the menu with /ydm open welcome <player>. If you have configured a per-menu command, you can also open it directly using that command.
Commands and permissions
| Command | Purpose | Permission |
|---|---|---|
/ydm reload |
Reload configuration, menus, and caches. | dialogmaster.admin |
/ydm debug |
Toggle diagnostic logging. | dialogmaster.admin |
/ydm open <menu> <player> |
Open a menu for a player. | dialogmaster.admin |
/ydm close <player> |
Close an open dialog. | dialogmaster.admin |
/menu |
Open the configured main menu. | dialogmaster.open |
/links |
Open the configured server-links menu. | dialogmaster.open |
/share |
Share the item held in the main hand. | dialogmaster.share |
Next steps
Learn the available Menu types, add Requirements and logic, or review the Configuration reference. If the menu does not appear, start with Troubleshooting.
Troubleshooting checklist
If a menu does not open, verify the filename, the top-level YAML key, indentation, permission, and console output after /ydm reload. For placeholder or requirement problems, run /ydm debug, reproduce the issue, and inspect the console logs.