xCustomMenu/config.yml

xCustomMenu 1.0.12 documentation

config.yml

Configuration reference for config.yml.

Raw YAML

Examples match release 1.0.12. Back up your configuration before editing. Use this plugin's reload command where supported; restart after dependency or JAR changes.

Settings in this file

Values shown below are sanitized defaults from the release JAR. Empty private fields must be configured locally.

Default value is shown below. Keep the type and YAML structure when editing this setting.

Setting

Default value is shown below. Keep the type and YAML structure when editing this setting.

Setting

Default value is shown below. Keep the type and YAML structure when editing this setting.

Setting

Pause-screen integration. Restart the server after changing the native visible layout or title.

Setting

Action execution timing and behavior after dialog buttons are clicked.

Setting

Player-facing messages and command feedback. Preserve the placeholder spelling used in each default.

Setting

Default configuration

Preserve YAML indentation. Never publish your configured keys, tokens or player data.

config-version: 3

prefix: "<bold><#55FFFF>xCustomMenu</#55FFFF></bold> <dark_gray>-></dark_gray> "
default-menu: main

pause-menu:
  enabled: true
  menu: main
  quick-action: true

# Wait after closing a dialog before executing actions. This gives inventory
# commands such as /ah enough time to replace the pause menu reliably.
actions:
  post-close-delay-ticks: 6

messages:
  reload: "<green>Config reloaded.</green> <gray>Restart the server after changing ESC menu titles or visible buttons.</gray>"
  only-player: "<red>This command can only be used by players.</red>"
  no-permission: "<red>You do not have permission to do that.</red>"
  unknown-menu: "<red>Unknown menu:</red> <white>{menu}</white>"
  unknown-button: "<red>Unknown button:</red> <white>{button}</white>"
  url: "<gray>Click here:</gray> <aqua>{url}</aqua>"
  copied: "<green>Copy button sent.</green>"