> For the complete documentation index, see [llms.txt](https://wiki.helpch.at/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.helpch.at/clips-plugins/deluxechat/placeholders.md).

# Placeholders

Plugin's placeholders

## Plugin's placeholders

**DeluxeChat** has some placeholders built-into it:

| Placeholder                      | Description                                                                                                                                                                       |
| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| %server%                         | This placeholder works only if **BungeeCord** is enabled. It displays the prefix of the server (`server_prefix` in the config) the player in when chatting globally (`/GToggle`). |
| %recipient\_\<PAPI Placeholder>% | This placeholder is for private message formats. It returns the recipient's PlaceholderAPI placeholder value. e.g. `%recipient_vault_prefix%`.                                    |

## PlaceholderAPI placeholders

**DeluxeChat** plugin provides [**PlaceholderAPI** ](https://www.spigotmc.org/resources/6245/)placeholders that you can use in any plugin that supports [**PlaceholderAPI**](https://www.spigotmc.org/resources/6245/).\
You can also use any [**PlaceholderAPI**](https://www.spigotmc.org/resources/6245/) placeholder in **DeluxeChat** plugin. ([PlaceholderAPI placeholders list](https://helpch.at/placeholders))

### Placeholders

| Placeholder                        | Return Value | Description                                                           |
| ---------------------------------- | ------------ | --------------------------------------------------------------------- |
| %deluxechat\_is\_pm\_toggled%      | Boolean      | Returns whether if the player has private messages toggled on or not. |
| %deluxechat\_social\_spy\_enabled% | Boolean      | Returns whether if social spy mode is enabled or not.                 |
| %deluxechat\_pm\_recipient%        | Text         | Returns the private message recipient name. (Used in PM format)       |

### Download

To use these placeholders, you have to download **DeluxeChat Expansion**. You can download it automatically by running:

> `/papi ecloud download DeluxeChat`\
> `/papi reload`

Or you can download it manually from the [eCloud](https://api.extendedclip.com/expansions/deluxechat/), and put it inside the `expansions` folder (folder path: `/plugins/PlaceholderAPI/expansions/`).


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://wiki.helpch.at/clips-plugins/deluxechat/placeholders.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
