> 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/player-ui-prompt.md).

# Player UI Prompt

Displays online players in a GUI inventory for selection.

| PlayerUI Prompt |                                                                                                |
| --------------- | ---------------------------------------------------------------------------------------------- |
| Prompt Key      | `p:` or `p:<filter>:`                                                                          |
| Break lines     | No                                                                                             |
| Color Support   | Yes, UI colors configuration can be found in `prompt-config.yml`                               |
| Configurable    | [Yes (`prompt-config.yml`)](/commandprompter/configuration/prompts-configuration/player-ui.md) |

### Filters

Filters limit which players appear in the GUI. You can customize the name format of filtered player heads in the [configuration](/commandprompter/configuration/prompts-configuration/player-ui/filter-format.md).

**Available Filters**:

| Filter              | Key                | Description                                                            |
| ------------------- | ------------------ | ---------------------------------------------------------------------- |
| **World**           | `w`                | Only show players in the same world.                                   |
| **Radial**          | `r<radius value>`  | Only show players within a specific radius.                            |
| Towny Town          | `tt`               | Only show players in the same Towny town.                              |
| Towny Nation        | `tn`               | Only show players in the same Towny nation.                            |
| Husk Towns          | `ht`               | Only show players in the same HuskTowns town.                          |
| LuckPerms Own Group | `lpo`              | Only show players in the same LuckPerms group.                         |
| LuckPerms Group     | `lpg<groupname>;`  | Only show players in the specified LuckPerms group. Must end with `;`. |
| WorldGuard Region   | `wgr`              | Only show players in the same WorldGuard region.                       |
| WorldGuard Member   | `wgrm<region_id>;` | Only show members of a specific WorldGuard region. Must end with `;`.  |
| WorldGuard Owner    | `wgro<region_id>;` | Only show owners of a specific WorldGuard region. Must end with `;`.   |
| Self Filter         | `s`                | Filter out the player who opened the prompt.                           |

{% hint style="info" %}
Filters can be combined (e.g., `wr10` or `r10w`). The format of the first filter listed will be used for head display names.
{% endhint %}

**Example**

```
/mute <p:Who do you want to mute?>
```

![](https://i.imgur.com/1aPNEWf.png)

Video example:

{% embed url="<https://cdn.discordapp.com/attachments/936346802951716880/1184752613003108392/2023-12-13_23-51-00.mp4?ex=658d1dda&hm=b4bcf5e70a5ec0109536bbcf05f97f9512752b3bf79d2fcc14dd6ba131347731&is=657aa8da>" %}


---

# 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/player-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.