> For the complete documentation index, see [llms.txt](https://imshadows-organization.gitbook.io/ryzenclans-or-wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://imshadows-organization.gitbook.io/ryzenclans-or-wiki/ryzenclans/quickstart-1.md).

# Variables and Permissions

### <mark style="color:blue;">**Permissions**</mark>

| Permissions              | Descriptions                    |
| ------------------------ | ------------------------------- |
| ryzenclans.\*            | Full access to the plugin       |
| ryzenclans.user          | Basic user permissions          |
| ryzenclans.admin         | Administrative permit           |
| ryzenclans.admin.chatspy | Permission to spy on clan chats |

### <mark style="color:$success;">**Variables**</mark>

| Placeholders                    | Descriptions                                       |
| ------------------------------- | -------------------------------------------------- |
| %ryzenclans\_clan\_name%        | Clan name with format and relation color           |
| %ryzenclans\_clan\_name\_clean% | Clan name without formatting (plain text only)     |
| %ryzenclans\_clan\_prefix%      | Clan prefix with format and relation color         |
| %ryzenclans\_clan\_tag%         | Clan tag with format and relation color            |
| %ryzenclans\_clan\_prefix\_raw% | Clan prefix exactly as stored, no extra formatting |
| %ryzenclans\_clan\_points%      | Clan points                                        |
| %ryzenclans\_clan\_size%        | Number of clan members                             |
| %ryzenclans\_clan\_rank%        | Player's rank within their clan                    |
| %ryzenclans\_clan\_leader%      | Clan leader's name                                 |
| %ryzenclans\_clan\_allies%      | Number of clan allies                              |
| %ryzenclans\_clan\_enemies%     | Number of clan enemies                             |
| %ryzenclans\_clan\_ff%          | Friendly fire state (Enabled / Disabled)           |
| %ryzenclans\_has\_clan%         | Whether the player has a clan (true / false)       |

| Placeholders                                 | Descriptions                                                               |
| -------------------------------------------- | -------------------------------------------------------------------------- |
| %ryzenclans\_is\_enemy\_\<clan>%             | Whether the given clan is an enemy (true / false)                          |
| %ryzenclans\_is\_ally\_\<clan>%              | Whether the given clan is an ally (true / false)                           |
| %ryzenclans\_is\_focused\_\<clan>%           | Whether the given clan is focused (true / false)                           |
| %ryzenclans\_clan\_relation\_\<player>%      | Relation to that player's clan (same, ally, enemy, focused, neutral, none) |
| %ryzenclans\_clan\_color\_\<player>%         | Relation color with that player's clan                                     |
| %ryzenclans\_clan\_name\_colored\_\<player>% | Target player's clan name, colored by relation                             |

| Placeholders                         | Descriptions                                              |
| ------------------------------------ | --------------------------------------------------------- |
| %rel\_ryzenclans\_rel\_clan\_name%   | Target's clan name, colored by viewer's relation          |
| %rel\_ryzenclans\_rel\_clan\_prefix% | Target's clan prefix, colored by viewer's relation        |
| %rel\_ryzenclans\_rel\_clan\_tag%    | Target's clan tag, colored by viewer's relation           |
| %rel\_ryzenclans\_rel\_clan\_color%  | Relation color between viewer and target                  |
| %rel\_ryzenclans\_rel\_relation%     | Relation type (same, ally, enemy, focused, neutral, none) |

| Placeholders                              | Descriptions                                  |
| ----------------------------------------- | --------------------------------------------- |
| %ryzenclans\_top\_points\_\<pos>%         | Name of the clan at position \<pos> by points |
| %ryzenclans\_top\_points\_\<pos>\_points% | Points of the clan at position \<pos>         |
| %ryzenclans\_top\_level\_\<pos>%          | Name of the clan at position \<pos> by level  |
| %ryzenclans\_top\_level\_\<pos>\_level%   | Level of the clan at position \<pos>          |
| %ryzenclans\_top\_size\_\<pos>%           | Name of the clan at position \<pos> by size   |
| %ryzenclans\_top\_size\_\<pos>\_size%     | Member count of the clan at position \<pos>   |
| %ryzenclans\_top\_kills\_\<pos>%          | Name of the clan at position \<pos> by kills  |
| %ryzenclans\_top\_kills\_\<pos>\_kills%   | Total kills of the clan at position \<pos>    |

Pattern: `%ryzenclans_top_<category>_<pos>_<field>%` — omitting `<field>` defaults to `name`.\
Categories: `points`, `level`, `size`, `kills`&#x20;

Fields: `name`, `points`, `level`, `size`, `kills`


---

# 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://imshadows-organization.gitbook.io/ryzenclans-or-wiki/ryzenclans/quickstart-1.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.