For the complete documentation index, see llms.txt. This page is also available as Markdown.

Usage

CommandPrompter intercepts a player's command when it contains prompt tags, pauses execution, collects the answers in order, substitutes them into the command, and dispatches the completed result.

By default, tags use angle brackets:

/ban <Who should be banned?> <Reason?>

If the answers are Steve and Griefing, the final command is /ban Steve Griefing.

Prompt types

Add a key at the start of a tag to choose a UI:

Key
Prompt

Keys configured in screen-mappings (prompt-config.yml) route to their configured built-in screen type. Third-party plugins can also register custom screen keys. An unknown or misspelled key now fails closed: CommandPrompter cancels interception and logs the unresolved key instead of silently opening Chat.

Reusable prompt definitions can be referenced with <@preset_id>. See Presets.

For multi-stage workflows, see Command Flows for target approvals, conditions, post-action transformers, and early termination.

Menu plugins such as DeluxeMenus can put inline tags directly in player commands:

Some menu plugins dispatch commands without a player command event. In that case, use a Console Delegate or Player Delegate:

Use %target_player% inside delegated commands when the target's name must be inserted into the completed command.

Delimiters and MiniMessage

Argument-Regex is the legacy name of the delimiter setting; only its first and last characters are used. With default < > delimiters, Ignore-MiniMessage: true keeps recognized standard MiniMessage tags from becoming prompts.

To include a literal configured delimiter, prefix it with a backslash (\< or \> by default). Reload after changing delimiter or MiniMessage settings.

For flags, validation, title displays, and post-command tags, continue with Arguments.

Last updated

Was this helpful?