> 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/glares-plugins/guilds/placeholders.md).

# Placeholders

Guild's placeholders

**Guilds** provides placeholders in various forms to support different APIs.

### [PlaceholderAPI](https://placeholderapi.com), [MVdWPlaceholderAPI](https://www.spigotmc.org/resources/11182/), and [EssentialsXChat](https://www.spigotmc.org/resources/9089/)

**Note:** For MVdWPlaceholderAPI, in order to ensure they all stay up-to-date with each other, we just hook into regular PlaceholderAPI. This means that PlaceholderAPI is **also** required.

**EssentialsX Example:**\
(Make sure you enabled the hook in the config and reboot for this to work)

```yaml
format: '<{GUILD} {DISPLAYNAME}> {MESSAGE}'
```

### Leaderboard Placeholders

<table><thead><tr><th width="319">PlaceholderAPI</th><th>Description</th></tr></thead><tbody><tr><td>%guilds_top_wins_name_#%</td><td>Name of guild with wins in # place</td></tr><tr><td>%guilds_top_wins_amount_#%</td><td>Amount of wins the guild in # place has</td></tr><tr><td>%guilds_top_losses_name_#%</td><td>Name of guild with losses in # place</td></tr><tr><td>%guilds_top_losses_amount_#%</td><td>Amount of losses the guild in # place has</td></tr><tr><td>%guilds_top_wlr_name_#%</td><td>Name of guild with win/loss ratio in # place</td></tr><tr><td>%guilds_top_wlr_amount_#%</td><td>The win/loss ratio of the guild in # place</td></tr></tbody></table>

### Regular Placeholders

| PlaceholderAPI             | MVdWPlaceholderAPI                         | EssentialsXChat           |
| -------------------------- | ------------------------------------------ | ------------------------- |
| %guilds\_name%             | {placeholderapi\_guilds\_name}             | {GUILD}                   |
| %guilds\_master%           | {placeholderapi\_guilds\_master}           | {GUILD\_MASTER}           |
| %guilds\_member\_count%    | {placeholderapi\_guilds\_member\_count}    | {GUILD\_MEMBER\_COUNT}    |
| %guilds\_prefix%           | {placeholderapi\_guilds\_prefix}           | {GUILD\_PREFIX}           |
| %guilds\_members\_online%  | {placeholderapi\_guilds\_members\_online}  | {GUILD\_MEMBERS\_ONLINE}  |
| %guilds\_status%           | {placeholderapi\_guilds\_status}           | {GUILD\_STATUS}           |
| %guilds\_role%             | {placeholderapi\_guilds\_role}             | {GUILD\_ROLE}             |
| %guilds\_tier%             | {placeholderapi\_guilds\_tier}             |                           |
| %guilds\_balance%          | {placeholderapi\_guilds\_balance}          |                           |
| %guilds\_balance\_raw%     |                                            |                           |
| %guilds\_tier\_name%       | {placeholderapi\_guilds\_tier\_name}       | {GUILD\_TIER\_NAME}       |
| %guilds\_id%               | {placeholderapi\_guilds\_id}               |                           |
| %guilds\_code\_amount%     | {placeholderapi\_guilds\_code\_amount}     |                           |
| %guilds\_max\_members%     | {placeholderapi\_guilds\_max\_members}     |                           |
| %guilds\_max\_balance%     | {placeholderapi\_guilds\_max\_balance}     |                           |
| %guilds\_formatted%        | {placeholderapi\_guilds\_formatted}        | {GUILD\_FORMATTED}        |
| %guilds\_challenge\_wins%  | {placeholderapi\_guilds\_challenge\_wins}  | {GUILD\_CHALLENGE\_WINS}  |
| %guilds\_challenge\_loses% | {placeholderapi\_guilds\_challenge\_loses} | {GUILD\_CHALLENGE\_LOSES} |
| %guilds\_motd%             | {placeholderapi\_guilds\_motd}             |                           |
| %guilds\_spying%           | {placeholderapi\_guilds\_spying}           |                           |

### Member Placeholders

`%guilds_member_#%` returns the name of the member in that position on the guild's member list, counting from 1. For example, `%guilds_member_1%` is the guild master and `%guilds_member_2%` is the next member.

These are separate from `%guilds_member_count%`, which gives you the total number of members. Positions past the end of the list return an empty string.


---

# 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/glares-plugins/guilds/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.