Prompt arguments affect one prompt. A normal inline tag has this shape:

<key:filter:Display text flags>

The key and filter are optional. Flags are whitespace-delimited tokens; text such as cost-int is not interpreted as -int.

Prompt keys

• Empty key: Chat

• a:: Anvil UI

• s::

• p::

• d::

• c:, confirm:, confirmation::

• i:, item::

Keys configured in screen-mappings (prompt-config.yml) route to their configured screen type. Plugins may register . An unresolved key fails closed and aborts the command; it does not fall back to Chat.

The title duration defaults to 70 ticks. Title flags work with every inline prompt and apply to an entire compound dialog block. The title delay counts against that prompt's Prompt-Timeout.

Use <@id> to load a prompt from presets.json. Preset IDs are case-sensitive and cannot contain spaces. Inline flags appended to a preset reference are ignored; configure title_display, sanitize, and other options in the preset itself. Preset sanitize values are honored ("sanitize": false preserves color codes and symbols in answers).

Prefix a configured opening or closing delimiter with a backslash to keep it literal. With the default delimiters, write \< or \>. CommandPrompter removes that escape when assembling the command.

Welcome to the official documentation for CommandPrompter! This documentation is designed to provide comprehensive guidance on configuring and utilizing the CommandPrompter plugin effectively.

About CommandPrompter

CommandPrompter is a powerful tool that enhances the command prompting experience in your Minecraft server. With its customizable configuration options, CommandPrompter allows you to tailor the command prompting process to suit your server's specific requirements.

Need Further Assistance?

If you encounter any issues or require additional assistance that isn't covered in this documentation, please don't hesitate to join our Discord server, where our friendly community is ready to help you out.

You can also chat with our custom developed support agent Skye . Skye knows everything about CommandPrompter, so just join the discord server and talk to Skye in the #skye-chat channel.

If you can't find the information you're looking for in this GitBook, please check the for additional resources and support.

We hope you find this documentation helpful in maximizing the potential of the CommandPrompter plugin for your Minecraft server!

Love using CommandPrompter? Support its growth and future development on Ko-fi, and be a part of shaping the next level of menu creation and command interactivity for your server! You will also get a special supporter role on the Discord server!

CommandPrompter turns static commands (like those in DeluxeMenus, ChestCommands, or Citizens NPCs) into interactive workflows.

The Problem

Traditional menu buttons execute fixed, hardcoded commands. You cannot easily prompt a player for dynamic input (such as a target player name, a reason, or an amount) without complex workarounds.

The Solution

By replacing static arguments with prompt placeholders (e.g., /ban <Who do you want to ban?> <Reason?>), CommandPrompter dynamically captures player input at runtime and constructs the final command.

Use Cases

• NPC Interaction: Ask for confirmation before performing actions like teleportation.

• Announcements: Let staff broadcast custom messages via a simple menu button.

• Economy/Shops: Prompt players for quantities when buying or selling items.

• Moderation: Query staff for player names, ban reasons, or mute durations dynamically.

Requirements

• A Paper-compatible server running Minecraft 26.1.2 or 26.2.x (Paper or a compatible fork such as Purpur).

• Java 25.

CommandPrompter 3.x is built against Paper APIs and is not a Spigot/Bukkit plugin. It declares Folia support and has no required plugin dependencies. Integrations such as PlaceholderAPI, LuckPerms, Towny, HuskTowns, WorldGuard, CarbonChat, and supported vanish plugins are optional.

Install

1. Download CommandPrompter from SpigotMC, Modrinth, or the GitHub releases.

2. Place the downloaded .jar in the server's plugins directory.

3. Start or restart the server.

4. Confirm that CommandPrompterPaper enabled without errors, then edit plugins/CommandPrompterPaper/config.yml and plugins/CommandPrompterPaper/prompt-config.yml as needed.

Anvil and Sign prompts use version-specific screen providers. If no provider matches the server version, those prompts fall back to chat and a warning is written to the console.

Prompt flags apply to one prompt; session tags run after the whole flow completes or is cancelled.

Multiple prompt flags can be combined as whitespace-delimited tokens. Compound Dialog flags apply to the whole block, and every input row consumes its own answer index.

This section covers the configuration options available in config.yml.

All administrative commands except the delegates are children of /commandprompter (alias /cmdp).

Commands

Delegate targets accept player names and single-target Minecraft selectors such as @p. The commands use Paper's singular player argument, so multi-target selectors such as @a are rejected.

When Enable-Permission is enabled, a prompted delegate flow starts only if the target has promptpaper.use; the console sender's delegate permission does not bypass that target-side gate. A direct delegated command with no prompt tags is still dispatched.

The permission declarations treat permissions as operator-only by default, except promptpaper.cancel which defaults to true (changed in 3.2.0).

Sets how many seconds a player has to answer each individual prompt.

Prompt-Timeout: 300

• Type: Integer

• Default: 300 seconds

A fresh fixed timer starts whenever the next prompt screen opens. A value of 0 or less disables timeouts. When a timer expires, the session is cancelled; the timeout message is shown only when Show-Prompt-Cancelled is enabled.

Session arguments affect the full prompt flow. CommandPrompter currently uses post-command tags:

Inline post-commands use zero-based answer references ({0}, {1}, ...). They require at least one actual prompt in the same command; a post-command tag by itself does not start a session.

See for executor inheritance, preset placeholders, and lifecycle rules.

Enables permission checks before a player can use the command prompting feature.

Configuration

Enable-Permission: true

• Type: Boolean

• Default: true (Default changed from false to true in 3.2.0)

Description

When set to true (the default in 3.2.0), players must have the promptpaper.use permission to trigger prompt interception.

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:

Keys configured in screen-mappings (prompt-config.yml) route to their configured built-in screen type. Third-party plugins can also register 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 .

For multi-stage workflows, see 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 or :

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

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 .

Sets the prefix on the first line of a Chat prompt.

• Type: String

• Default: <gradient:gold:yellow>[Prompter]</gradient>

MiniMessage and legacy & color codes are supported. The prefix is not added to GUI prompts, command feedback, or every localized plugin message. In a multiline Chat prompt, it appears only on the first line.

Despite its legacy name, Argument-Regex is not evaluated as a regular expression. CommandPrompter trims the value and uses only its first and last characters as the opening and closing prompt delimiters. The middle characters are ignored.

Argument-Regex: <.*?>

• Type: String of at least three characters

• Default: <.*?>

• Effective delimiters: < and >

Examples:

Each delimiter must be one character. An invalid value logs an error and falls back to < >. Run /cmdp reload after changing it.

In command text, prefix a delimiter with a backslash when it should be literal rather than start or end a tag. This escaping belongs in the command being parsed, not in the Argument-Regex configuration value.

The Syntax section in config.yml controls prompt delimiters and post-action template placeholders:

Syntax:
  Prompt:
    Open: '<'
    Close: '>'
  Template:
    Open: '{'
    Close: '}'
    Transform-Separator: ':'
    Escape: '\'

With these defaults, <a:Name> is a prompt tag, {0} is the first answer in a post-action template, {0:upper} applies a transformer, and \{ inserts a literal template opener.

Argument-Regex remains as a deprecated compatibility setting for prompt delimiters. When Syntax.Prompt still has its defaults and Argument-Regex was customized, CommandPrompter derives the effective opening and closing characters from the legacy value. Prefer Syntax.Prompt for new configuration.

Each syntax token must be nonempty, no more than 16 characters, and contain no whitespace, control characters, or quotes. Tokens cannot be equal or overlap by prefix. A conflicting syntax configuration rejects reload and leaves the previous validated parser active.

Changing template delimiters also changes placeholders and transformers in trusted definitions such as presets.json. Keep the configured syntax consistent anywhere commands are authored.

Arguments are special tags or flags added to a prompt to customize its behavior or the behavior of the entire command execution.

CommandPrompter supports two types of arguments:

1. : Modify the behavior or appearance of a specific prompt (e.g., UI type, input validation).

2. : Modify the outcome or behavior of the entire command flow (e.g., running post-commands).

Controls whether CommandPrompter sends feedback when a prompt session is cancelled or times out.

• Type: Boolean

• Default: true

Disabling this suppresses both the normal cancellation message and the timeout message. It does not prevent the session from being cancelled.

Determines whether CommandPrompter sends the fully constructed command to the player in chat before executing it.

• Type: Boolean

• Default: true

Sets the answer that cancels an active prompt.

Cancel-Keyword: cancel

• Type: String

• Default: cancel

Cancel-Keyword governs typed input in Chat and Anvil prompts. Matching is trimmed, color-stripped, and case-insensitive. Typed Dialog answers are checked too: for a compound dialog, entering the keyword in any input row cancels the whole session. Closing an Anvil or Player UI also cancels, and an empty Sign submission cancels. Escape is disabled for native Dialogs, so use Cancel/Exit when the player needs to dismiss one without submitting the keyword.

Clickable cancel controls always execute /cmdp cancel and are independent of Cancel-Keyword.

Prevents recognized standard MiniMessage formatting tags from being interpreted as prompts when angle brackets are also the prompt delimiters.

Ignore-MiniMessage: true

• Type: Boolean

• Default: true

This setting is active only when Argument-Regex produces < and > delimiters. Valid standard tags such as <red>, </red>, and <gradient:gold:yellow> remain in the command instead of opening prompt sessions. Unknown angle-bracket content is still treated as a prompt.

Run /cmdp reload after changing this setting.

Controls whether CommandPrompter's top-level commands are advertised to players in command completion.

Command-Tab-Complete: true

• Type: Boolean

• Default: true

When disabled, commandprompter, cmdp, consoledelegate, cd, playerdelegate, and pd are removed from the command list sent to players. This does not change permissions and is unrelated to the Dialog d:tab input.

Specifies a list of commands that CommandPrompter will completely ignore and bypass when checking for prompt patterns.

Configuration

Ignored-Commands:
  - sampleCommand
  - sampleCommand2

• Type: List of Strings

• Default: [sampleCommand, sampleCommand2]

Description

Commands on this list will not trigger any prompt detection.

• Do not include the leading / prefix.

Defines temporary permission groups for Player Delegate.

Permission-Attachment:
  ticks: 0
  Permissions:
    GAMEMODE:
      - bukkit.command.gamemode
      - essentials.gamemode.survival
      - essentials.gamemode.creative

ticks sets how long (in server ticks) the permission attachment persists after a delegated command dispatch (default changed from 1 to 0 in 3.2.0; 0 = removed immediately after dispatch). A positive value schedules removal after that many server ticks; 0 or a negative value removes it immediately. If command dispatch fails, throws an exception, or removal-scheduling fails, the attachment is removed immediately.

Each key under Permissions is passed as the second argument to /playerdelegate. Tab completion for the permission-key argument only suggests actually configured group keys.

Defines a list of commands players are permitted to run while an active prompt session is open, without canceling the prompt.

Configuration

Allowed-Commands-In-Prompt:
  - sampleCommand
  - sampleCommand2

• Type: List of Strings

• Default: [sampleCommand, sampleCommand2]

Important Notes

• Do not include the leading / prefix.

• Allowed commands that contain prompts will still be blocked.

Controls the settings for Chat Prompt.

• Clickable-Cancel

• Cancel-Message

• Cancel-Hover-Message

Enables verbose logging for troubleshooting and diagnostics.

• Type: Boolean

• Default: false

Selects the locale used for CommandPrompter messages.

Locale: en_US

• Type: String

• Default: en_US

Bundled locales are en_US, es_ES, fr_FR, ja_JP, ko_KR, pirate, pl_PL, pt_BR, tl_PH, and zh_CN.

Custom UTF-8 overrides use this path:

For example, Locale: de_DE loads messages_de_DE.properties. The fallback resolution chain for each message key is:

1. Custom disk override (plugins/CommandPrompterPaper/locales/messages_<locale>.properties)

2. Bundled JAR resource for the selected locale

3. Bundled en_US default

PlaceholderAPI placeholders inside message values expand against the receiving player (player context is passed to localized feedback). Run /cmdp reload after changing the locale or an override file.

Enables ANSI color coding and stylized formatting for console logs.

• Type: Boolean

• Default: true

prompt-config.yml contains the UI defaults for Chat, Player, Anvil, Sign, Dialog, and Confirmation prompts, plus input-validation definitions.

The file is generated in plugins/CommandPrompterPaper/ on first start. Edit it while the server is stopped or use /cmdp reload after saving changes. Reload cancels active prompt sessions.

Continue with the page for the UI you want to configure:

• Chat Prompt

Specifies the clickable text message displayed for canceling a text prompt.

Edit prompt-config.yml:

Controls the cancel affordance appended to inline Chat prompts.

TextPrompt:
  Clickable-Cancel: true

• Type: Boolean

• Default: true

When enabled (true), CommandPrompter appends Cancel-Message to the prompt text and configures it to run /cmdp cancel with the configured hover text on click. Disabling this setting (false) suppresses the cancel text entirely.

Clicking the cancel control executes /cmdp cancel. Because promptpaper.cancel defaults to true, non-operator players can use the clickable cancel control out of the box. Typing the configured cancel keyword directly in chat never requires a permission.

Chat prompt presets have independent cancel.send and cancel.clickable properties.

Specifies the message shown when a player hovers over the clickable cancel option in a text prompt.

Edit prompt-config.yml:

Sets the Bukkit event priority used to capture Chat prompt answers.

TextPrompt:
  Response-Listener-Priority: LOWEST

• Type: String

• Default: LOWEST (Default changed from DEFAULT to LOWEST in 3.2.0)

Valid Bukkit priorities are LOWEST, LOW, NORMAL, HIGH, HIGHEST, and MONITOR.

This value applies to the fallback Bukkit Chat listener. When the CarbonChat integration owns Chat prompt input, CarbonChat's event subscription is used instead.

Configures the visual aspects and behavior of the Player UI Prompt.

• Skull-Name-Format

• Skull Custom Model Data

• Size

Determines the number of slots in the Player UI inventory.

Edit prompt-config.yml:

Determines the delay (in ticks) after a player joins before their head is cached.

Edit prompt-config.yml:

The accepted range is 0–2400 ticks. A value of 0 caches the head immediately on join.

• Type: Integer

• Default: 256

Cache-Size sets the maximum capacity of the bounded LRU cache used to store rendered player head item stacks (<= 0 creates an unbounded cache).

The list of displayed players in the Player UI is always derived fresh from online players at open time. Cache eviction only clears cached skull items from memory and never hides online players from the UI.

Configure the buttons used for navigation and cancellation in the Player UI (Previous, Next, Cancel, and Search).

Configuration

Edit prompt-config.yml:

PlayerUI:
  Previous:
    Item: Feather
    Custom-Model-Data: 0
    Column: 3
    Text: '&7◀◀ Previous'
  Next:
    Item: Feather
    Custom-Model-Data: 0
    Column: 7
    Text: 'Next ▶▶'
  Cancel:
    Item: Barrier
    Custom-Model-Data: 0
    Column: 5
    Text: '&7Cancel ✘'
  Search:
    Item: Name_Tag
    Custom-Model-Data: 0
    Column: 9
    Text: '&6Search ⌕'

Options

• Item: The Minecraft material for the button item. Must be a valid material from the Minecraft Materials list.

• Custom-Model-Data: The custom model data value for the item.

• Column: The 1-based inventory column (1–9) in the bottom control row, mapping to zero-based inventory slots 0–8 (e.g. Column 3 maps to slot 2). Out-of-range values are clamped to the 1–9 range with a console warning.

• Text: The display name of the button item.

Specifies the custom model data for player heads displayed in the Player UI.

Edit prompt-config.yml:

When a player clicks the Search button in the Player UI, CommandPrompter opens an Anvil GUI styled using these settings (Title, Material, CustomModelData, and prefilled Text). Submitting a query in the Anvil filters the displayed heads.

Chat capture is used only as a fallback when no NMS screen provider is available on the server.

Configure the visible Search button in the Player UI inventory on .

• Type: String

• Default: &cNo players found!

When a player list or search filter results in 0 matching players, a single non-clickable BARRIER item displaying this message is rendered in the center of the head inventory grid.

Determines whether player heads in the Player UI are sorted alphabetically by player name.

Edit prompt-config.yml:

%s represents a player's name. Formatting supports MiniMessage tags and legacy color codes.

When a filter is applied to a Player UI prompt, head display names use the configured format of the leftmost (first) filter token (for example, w uses Filter-Format.World and r uses Filter-Format.Radial). Any subsequent filters in a combined filter string only contribute to narrowing the player set.

If no filter format applies (or when no filter is used), heads retain the global PlayerUI.Skull-Name-Format.

Determines whether the first line of the prompt (before a {br} line break) is used as the title of the Anvil GUI.

Edit prompt-config.yml:

Manages the settings related to Anvil UI Prompt.

• Enable-Title

• Custom-Title

• Prompt-Message

Sets the display name of the input item in an inline Anvil prompt. That item name is also the initial text presented by Minecraft's rename field.

• Type: String

• Default: empty

For Anvil presets, left_button.button_text overrides this value.

Max-Answer-Length limits each submitted prompt answer before it is added to a session.

The default is 256 characters. The accepted configuration range is 1–1024. An answer over the configured limit is rejected with a player-visible validation error and the current prompt remains active for another attempt.

This limit applies to untrusted player input. Other flow resources—including preset templates, PlaceholderAPI values, prompt counts, and condition depth—have separate hard bounds and fail closed when exceeded.

This configuration option sets the hover text for the cancel item in the Anvil GUI.

• Type: String

• Default: &cClick to Cancel

Sets the text that appears when a player hovers over the cancel item in the Anvil GUI.

Specifies the items displayed in the Anvil GUI.

• Item: The item displayed in the input slot.

• ResultItem: The item displayed in the result slot.

• CancelItem: The item displayed in the cancel slot (only used when Enable-Cancel-Item is true).

Edit prompt-config.yml:

This configuration option determines whether a cancel item should be shown on the right input slot of the Anvil GUI.

• Type: Boolean

• Default: false

When set to true, a cancel item will be displayed in the Anvil GUI, allowing players to easily cancel the prompt.

This configuration option hides the additional tooltip on Anvil GUI items.

• Type: Boolean

• Default: false

When set to true, the tooltips for the respective items in the Anvil GUI will be hidden. This is useful for creating a cleaner UI.

Sets a custom title for the Anvil GUI (used when Enable-Title is enabled).

Edit prompt-config.yml:

plugins/CommandPrompterPaper/item-catalogs.yml defines the read-only choices shown by item prompts using -source:catalog.

The file is extracted on first start. It must contain an all category:

Use a category from an item prompt:

Validation rules

• Category IDs must match ^[a-z0-9_.-]{1,64}$.

• all is required.

• The file may contain at most 256 categories and be at most 1 MiB.

• Each category may contain at most 1024 entries.

• Every entry must resolve to a valid item material on the running server.

• Duplicate entries inside one category are rejected.

Catalog screens show 45 entries per page. A catalog selection can return key, material, or amount; slot is invalid because a catalog item has no player inventory slot. Catalog amount is always 1.

Run /cmdp reload after editing the file. Reload validates the complete file before publishing it. If validation fails, CommandPrompter keeps the previous catalog snapshot active and reports the error instead of partially applying the edit.

Specifies the material used for signs in the Sign UI.

Configuration

Edit prompt-config.yml:

Valid Values

Must be a valid Minecraft material (typically containing _SIGN). For a list of valid materials, refer to the Minecraft Materials documentation. Common examples:

• OAK_SIGN

• SPRUCE_SIGN

• BIRCH_SIGN

• ACACIA_SIGN

Controls how inline Sign prompt text and writable rows are arranged.

SignUI:
  Input-Field-Location: bottom

• Type: String

• Default: bottom

In single-argument mode, unchanged prompt lines and empty lines are filtered out before combining the answer. In labeled multi-argument mode (label1:\nlabel2:), CommandPrompter extracts and joins the text following each label:.

Determines whether items in the Anvil GUI display with an enchanted visual effect.

Configuration

Edit prompt-config.yml:

AnvilGUI:
  Item:
    Enchanted: false
  ResultItem:
    Enchanted: false
  CancelItem:
    Enchanted: false

Options

• Item.Enchanted: Controls the main input item.

• ResultItem.Enchanted: Controls the result item.

• CancelItem.Enchanted: Controls the cancel item.

Defines the configuration for the .

Set Locale in config.yml and reload:

Locale: en_US

Bundled locales are en_US, es_ES, fr_FR, ja_JP, ko_KR, pirate, pl_PL, pt_BR, tl_PH, and zh_CN.

Create a UTF-8 properties file named:

Only overridden keys are required. Resolution for each key is:

1. the on-disk selected-locale override;

2. the selected locale bundled in the plugin;

3. bundled en_US.

Values support MiniMessage, built-in %name% substitutions, and PlaceholderAPI expansion against the receiving player (player context is passed to localized messages). Run /cmdp reload after changing the locale or file.

Chat is the default prompt and has no key.

/gamemode <&6&lWhat gamemode?{br}0. Survival{br}1. Creative>

{br} splits the display into separate chat messages. Prompt-Prefix is added to the first line, and the configured cancel control is appended to the last line. The clickable cancel control runs /cmdp cancel (which all players can use by default as promptpaper.cancel defaults to true in 3.2.0).

The player's next chat message becomes the answer. Typing the configured Cancel-Keyword also cancels the session and does not require command permissions. MiniMessage and legacy color codes are supported in the display text; normal answer sanitation is controlled by -ds.

The Dialog UI uses Paper's native dialog API. These values are defaults for inline <d:...> prompts; inline constraints and preset fields can override them.

DialogUI:
  Title: Prompt
  Confirm-Button:
    Label: <green>Confirm</green>
    Tooltip: Confirm this action
  Cancel-Button:
    Label: <red>Cancel</red>
    Tooltip: Cancel this action
  Defaults:
    Text:
      MaxLength: 256
      Multiline: false
      MultilineMaxLines: 4
      Width: 200
    Choice:
      Default-Options: ''
    Number:
      Min: 0.0
      Max: 100.0
      Step: 1.0
    Tab:
      MaxButtons: 5

Window and buttons

• Title is the fallback for ordinary inline dialogs when no d:title row overrides it, and it is always used by the d:tab text-input fallback. A successful button-form d:tab instead uses that tag's display text as its window title. (d:tab cannot be combined with the compound-only d:title row.) JSON Dialog presets can supply their own title.

• Confirm and Cancel labels and tooltips accept MiniMessage and legacy color codes.

• Prompt dialogs do not close when the player presses Escape or activates a component action such as open_url. Confirm, Cancel, Exit, or an answer button ends the dialog explicitly.

• MaxLength: 1–8192 characters.

• Multiline: enables multiline input.

• MultilineMaxLines: 1–16; used when multiline is enabled.

An inline text[...] filter can override all three numeric values.

Default-Options is a comma-separated fallback for <d:choice:Label>. An explicit choice[one,two] list takes precedence. With no configured or inline options, the client receives one empty option.

Min, Max, and Step must be finite, with Min < Max and Step > 0. The initial value defaults to the midpoint. Inline number constraints can override the range, step, and initial value.

MaxButtons must be 1–256. At or below the threshold, tab completions become buttons. Zero completions or a count above the threshold produces a text-input fallback.

Use a: to capture text through the native Anvil rename interface.

/nick <a:Choose a new nickname>

For inline prompts, the display text becomes the Anvil title when titles are enabled and no custom title is configured. If it contains {br}, only the text before the first marker is used as that fallback title; later segments are not rendered as lore.

The player types into the rename field and clicks the output/result slot to submit. Closing the UI, clicking an enabled cancel item, or submitting the configured cancel keyword cancels the session. Sanitization strips color codes by default, but -ds or preset "sanitize": false preserves them.

Preset support

Anvil preset definitions in presets.json are fully wired in 3.2.0:

• title: Sets the Anvil window title.

• prompt_text / left_button.button_text: Sets the initial text in the rename field.

• left_button.*: Configures the input item (show, button_text, button_icon, button_hover_text, custom_model_data).

• right_button.*: Configures the cancel item (show, button_text, button_icon, button_hover_text, custom_model_data).

Anvil prompts use version-specific providers for Minecraft 26.1.2 and 26.2.x. If a compatible provider cannot open, CommandPrompter falls back to a Chat prompt.

Specifies the display name format for player heads in the Player UI.

Edit prompt-config.yml:

• The %s placeholder represents the player's name and is replaced dynamically.

Use p: to show a paginated inventory of visible online players. Clicking a head returns that player's name.

/mute <p:Who should be muted?>

Use <p:filter:Display text> for one player filter:

/teleport <p:w:Choose someone in your world>

Filters

Only filters whose optional integration is installed are registered. Multiple filter tokens can be combined and will compose (intersect) — for example, r10s selects players within 10 blocks AND excludes the prompting player. The filter parser uses an anchored longest-match tokenizer, ensuring that specific keys (such as wgr or wgrm...;) are matched correctly without being shadowed by shorter keys like w. If a filter token is not recognized, it is skipped.

• Search: Clicking the Search button opens an Anvil GUI configured via PlayerUI.Search.AnvilItem.* for entering a name filter. If no NMS anvil provider is available, it gracefully falls back to chat input. Matching heads are then displayed in the updated grid.

• Empty State: When no online players match the filter or search query, a non-clickable BARRIER item is displayed in the center of the inventory with PlayerUI.Empty-Message.

Closing the inventory or clicking Cancel cancels the prompt session.

See .

presets.json defines reusable prompts, post-commands, approval gates, and conditional post-commands. CommandPrompter extracts a sample file to plugins/CommandPrompterPaper/presets.json on first start and reloads it with /cmdp reload.

Use this root shape for schema-compatible files:

The runtime treats an absent array as empty, although the documentation schema requires prompts and post_commands. The file is limited to 1 MiB and each array to 256 definitions. A failed load keeps the previous in-memory preset snapshot.

IDs are case-sensitive, must be nonempty, and must be unique across all four definition kinds. Duplicate and cross-kind collisions reject the complete reload. Prompt and post-command IDs should not contain whitespace because <@id>

Use s: to collect text through a Sign editor.

/gamemode <s:What gamemode?>

Inline display text is split on {br} and placed around writable rows according to SignUI.Input-Field-Location:

• bottom (default): Prompt text occupies lines 1–3 and player input is captured on line 4.

• top: Input is captured on line 1 and prompt text occupies lines 2–4.

• bottom-aggregate: Prompt lines are placed at the top and all remaining bottom lines are aggregated (concatenated with spaces) into the final argument.

• top-aggregate: Prompt lines are placed at the bottom and all remaining top lines are aggregated (concatenated with spaces) into the final argument.

In normal mode, single line modes (top, bottom) take the designated input line, while aggregate modes concatenate all non-prompt input lines with spaces.

Multi-argument mode activates only when at least one {br} segment is exactly a non-space label followed by a colon, such as Mode: or Value:. On submission, each row matching label:anything contributes only the text after its first colon.

If the player edits the labeled rows to Mode:add and Value:1600, the answer is add 1600.

Labels containing spaces, or a segment that already has text after its colon, do not activate multi-argument mode. Sign answers always have color codes stripped. An empty result, the cancel keyword, or closing/cancelling the screen cancels the session.

Sign prompts use version-specific providers for Minecraft 26.1.2 and 26.2.x and fall back to Chat if no compatible provider opens.

See .

Use i: or item: to let a player select an item instead of typing a material or slot.

/auction create <i:Select an item>

The screen is read-only. CommandPrompter displays server-side item snapshots, cancels inventory movement, and verifies a physical item again when it is clicked. If the item changes, the player can retry; three consecutive snapshot mismatches cancel the prompt.

Sources

Choose the source with -source:<source>:

The selected item contributes one answer token.

Choose the output with -out:<format>:

Logical slot numbers are 0–8 for the hotbar, 9–35 for main storage, 36–39 for armor (feet through head), and 40 for offhand.

Unknown sources, outputs, and categories fail closed. -cat on a non-catalog source and -out:slot on a catalog also reject the command.

Reference it with <@combat_reward>. source defaults to inventory, output defaults to key, and a catalog without category uses all.

See to define catalog categories and reload behavior.

Use c:, confirm:, or confirmation: to place a binary decision in a prompt flow.

/town disband <c:Disband your town?>

Confirmation prompts have two behaviors:

• Gate mode (default): Confirm continues without inserting an argument. Decline, closing the screen, or cancelling stops the command.

• Value mode (-value): Confirm inserts true; Decline inserts false, and the command continues.

Separate the question, confirm label, and cancel label with |:

Quote text that contains a pipe. Use \" for a literal quote inside quoted text.

The mode defaults to ConfirmationUI.Default-Mode in prompt-config.yml. Invalid modes, malformed quotes, duplicate structural flags, and out-of-range timeouts reject the command instead of guessing a fallback.

A confirmation prompt always asks the player who started the command and runs during input collection. It is useful for preventing accidental actions.

An asks another resolved player after all local inputs have been collected but before the primary command runs. Use approval gates for consent or authorization workflows.

Reference it with <@confirm_payment>. mode, title, confirm_text, cancel_text, value_mode, sound, and timeout are optional. prompt_text and id are required.

prompt-config.yml controls the default presentation and GUI items:

GUI slots must be distinct numbers from 0 through 26. Default-Mode accepts only gui, dialog, or chat. A failed configuration reload keeps the previously validated settings active.

Closing a GUI or dialog counts as Decline in gate mode. Timeouts, disconnects, reloads, and runtime errors cancel the session without treating a programmatic close as a player decision.

Use d: to build a native Paper dialog. Dialog prompts support text, number, choice, tab-completion, and compound layouts.

Text

An empty or unknown filter becomes a text field. text may be written explicitly.

<d:Question>
<d:text:Question>
<d:text[256,4,300]:Question>
<d:text[max_length=256,max_lines=4,width=300]:Question>

Positional values are maxLength,maxLines,width. Keyed values may appear in any order. Each numeric override is clamped to 1–8192; max_lines > 1 enables multiline input.

Number

num, number, and numberrange are aliases.

<d:num[0,100]:Percentage>
<d:num[0,100,5]:Percentage>
<d:num[0,100,5,50]:Percentage>

The positions are min,max,step,initial. If min >= max, the effective maximum becomes min + 1. A nonpositive step becomes 1. Without an inline initial value, an overridden range starts at its midpoint; explicit initial values are clamped into the range.

Blank options are discarded, the first remaining option is selected initially, and its display text is also the returned answer. Omitting the list uses DialogUI.Defaults.Choice.Default-Options.

CommandPrompter requests completions for the command assembled up to this prompt. One button is shown per completion when the count is between 1 and the effective threshold. Zero completions or too many completions opens a text-input fallback. The inline threshold has a minimum of 1.

d:tab cannot be used inside a compound dialog.

Separate rows with top-level &&. Spaces around && are optional.

The available row filters are:

title and body are compound-only. Using either as a standalone prompt sends an error and cancels the session.

In 3.2.0, layout rows (title and body) produce 0 answers and do not consume answer positions:

• Multi-input dialogs produce exactly N answers (one per input row).

• Info-only dialogs (containing only title and body rows) produce 0 answers.

• Zero-arity dialogs and layout rows never shift {input:N} or {N} answer indices in post-commands.

Row-processing flags such as -ds, -iv:alias, -int, and -str are validated against actual input rows. The -t flag is extracted once for the whole compound and shows one Adventure title before the native dialog; it is separate from d:title, which sets the dialog window title.

Prompt dialogs cannot be dismissed with Escape. Client component actions—including MiniMessage open_url links in body text—leave the dialog open. Confirm, Cancel, Exit, or an answer button closes the dialog explicitly and then completes or cancels the session. Timeout, /cmdp cancel, reload, disconnect, and other server-side teardown can also close it; opening a link does not reset Prompt-Timeout.

With the default < > prompt delimiters, escape the nested MiniMessage delimiters so they do not terminate the outer prompt tag:

The backslashes are removed before MiniMessage renders the body. Another option is to configure non-angle prompt delimiters, such as {.*?}, so ordinary MiniMessage <click>...</click> tags do not conflict.

See .

Presets are reusable prompt, post-command, approval-gate, and conditional post-command definitions stored in plugins/CommandPrompterPaper/presets.json.

The ID is case-sensitive and stops at the first space. Typing <@ in chat suggests configured preset IDs via tab completion. Inline flags appended inside a preset reference are ignored; configure behavior in JSON. Preset sanitize settings are honored ("sanitize": false preserves formatting and special characters in input).

Multi-input dialog presets produce N separate answers (one for each input row), while zero-input dialog presets produce 0 answers without consuming answer slots.

The post-command's JSON execution_policy decides whether it runs on completion or cancellation. execute_as

CommandPrompter has no required plugin dependencies. When a supported plugin is present, its hook is loaded automatically.

Filter syntax is documented on . Multiple filters compose (intersect) using an anchored longest-match parser (e.g. r10s selects players within 10 blocks AND excludes self), so short keys like w never shadow longer keys like wgr. If an optional filter plugin is absent, its filter is not registered and unrecognized filter tokens are skipped.

Supported vanish integrations (SuperVanish, PremiumVanish, VanishNoPacket) enforce vanish checks at the head-cache boundary: vanished players are never added to the cache and are filtered out across all views.

When PlaceholderAPI is installed, placeholders expand in all player-visible presentation fields across every prompt type:

• Chat: Prompt text, cancel message, and hover message.

• Anvil: Window title, prompt text, and button text / hover lore.

• Sign: Prompt text and all default lines.

• Player UI: Prompt text and button text / hover lore.

Semantic fields (such as preset IDs, tag keys, validator aliases, numeric constraints, action return values, and player-submitted answers) are never expanded.

Post-command tags dispatch additional commands after a prompt flow completes or is cancelled. A post-command-only string does not start a session; at least one prompt must be present.

Inline syntax

@console and @player are whitespace-delimited tokens and may appear anywhere in the inline command body.

Inline answer references are zero-based:

An out-of-range inline {N} reference fails that post-action unless it uses a default="..." transformer. Answer substitutions are escaped and inserted as one command token.

An inline command with no executor marker inherits the main command's dispatch context:

• A normal player command runs it as that player.

• Console Delegate runs it as console.

• Player Delegate runs it as the target player and inherits the permission attachment.

Explicit @player or @console overrides that inheritance. In particular, explicit @player does not carry a Player Delegate permission attachment.

When a post-command resolves to execute as console (via explicit @console, a preset with execute_as: "console", or inherited console delegation), it is permitted only when:

• The session originated from /consoledelegate, OR

• The player is an operator (OP), OR

• The player holds promptpaper.pcm.console, promptpaper.admin, or promptpaper.consoledelegate.

If none of these conditions are met, the post-command is dropped with a warning logged to the server console.

Answer indexing follows the effective answers collected during the session:

• Zero-arity prompts (such as info-only dialogs with no input rows or layout-only title/body rows) contribute 0 answers and never shift answer indices.

• Multi-input dialogs contribute exactly N answers (one per input field).

• Inline post-command placeholders remain zero-based ({0}, {1}

Reference a definition in presets.json with <!@id>. The preset's execution_policy, execute_as, and delay_ticks are authoritative. Parser hints such as <!!@id> or <!:40@id> do not override the preset.

Preset placeholders are one-based:

• {input} and {input:1}: first collected answer

• {input:N}: Nth collected answer

• {0}, {1}

Append one transformer to an answer placeholder, such as {input:1:upper}, {0:trim}, or {1:math(*1.5)}. Out-of-range references without a default="..." transformer fail the action. Duplicate preset post-command references within the same lifecycle event are deduplicated and executed at most once.

<!@id> can also reference a conditional post-command from the conditional_post_commands array. Its condition selects a trusted if_true or if_false action. See for approval gates, conditions, transformers, and -breakIf.

<!!command> receives any answers collected before cancellation. A preset runs only when its configured execution_policy matches the actual session result, even if the reference used the opposite marker.

See for the full JSON format.

Validation rejects an answer, sends the configured error message, and reopens the same prompt. Apply a configured validator with the whitespace-delimited -iv:<alias> flag. Aliases are case-sensitive and must contain only word characters (letters, digits, or underscore); a hyphenated alias does not parse as one validator flag.

Configured validators

Each entry under Input-Validation has an Alias and Err-Message and may enable one or more checks:

When an entry enables multiple checks, all of them must pass. Referencing an unknown validator alias aborts session start (the command is not executed), logs a severe fail-fast error to the server console, and sends command.error.missing_validator to the player ("Configuration error: An unknown input validator is referenced. See server console for details.").

JavaScript expressions can reference:

• %prompt_input%, replaced with the submitted answer

• BukkitServer

• BukkitPlayer

• -int accepts only values handled by Java Integer.parseInt: signed 32-bit integers.

• -str requires a nonblank answer.

For compound dialogs, block-level validators and type flags are checked against every row. Do not apply them to a compound containing title or body rows because layout rows submit empty answers.