> For the complete documentation index, see [llms.txt](https://cyr1en.gitbook.io/commandprompter/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cyr1en.gitbook.io/commandprompter/prompts/dialog-ui-prompt.md).

# Dialog UI Prompt

The Dialog UI prompt allows you to prompt players using a custom dialog window. It is triggered using the `<d:...>` tag.

## Usage

The Dialog UI supports several kinds of inputs:

### Text Input

If no filter is provided, it defaults to a text field (single-line or multi-line depending on configuration).

```
<d:Display Text>
```

### Number Input

Use the `num` filter to prompt for a number.

```
<d:num[min,max]:Display Text>
<d:num[min,max,step]:Display Text>
<d:num[min,max,step,initial]:Display Text>
```

### Choice Input

Use the `choice` filter to prompt for a single-select dropdown.

```
<d:choice[opt1,opt2,...]:Display Text>
```

### Tab Input

Use the `tab` filter to dynamically fetch tab completions for the command.

```
<d:tab:Display Text>
<d:tab[max_buttons]:Display Text>
```

If the number of available tab completions is at or below the `MaxButtons` threshold (configured in `prompt-config.yml` or overridden inline via `[max_buttons]`), the dialog will display them as a grid of buttons. If there are too many completions, it will automatically fall back to a standard text input field.

### Title Filter

Use the `title` filter to add a static header text block.

```
<d:title:Display Text>
```

{% hint style="warning" %}
The `title` filter is not supported for non-compound tags and will cause an error. It must only be used inside compound dialog tags (`&&`).
{% endhint %}

### Compound Prompts

You can combine multiple inputs into a single dialog window by splitting sub-tags with `&&` inside a single `<d:...>` block.

```
<d:choice[set,add]:Action && d:num[0,24]:Value>
```

This will render ONE dialog with TWO input rows. Block-level flags (like `-ds`, `-iv:alias`) apply to the whole block and should be placed at the end.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cyr1en.gitbook.io/commandprompter/prompts/dialog-ui-prompt.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.