> 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/configuration/prompts-configuration/dialog-ui.md).

# Dialog UI

The Dialog UI is a new feature in CommandPrompter v3 that allows you to prompt players using a custom dialog window. It supports text input, number input, and choice selection.

## Configuration

```yaml
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
    Choice:
      Default-Options: ''
    Number:
      Min: 0.0
      Max: 100.0
      Step: 1.0
    Tab:
      MaxButtons: 5
```

### Title

The title of the dialog window.

### Confirm-Button

The label and tooltip for the confirm button.

### Cancel-Button

The label and tooltip for the cancel button.

### Defaults

Default settings for different types of dialog inputs:

* **Text**: Maximum length, multiline support, and maximum lines for multiline text.
* **Choice**: Default options for the choice dropdown.
* **Number**: Minimum, maximum, and step values for number input.
* **Tab**: Maximum number of buttons to show for tab completions before falling back to text input.


---

# 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/configuration/prompts-configuration/dialog-ui.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.