> For the complete documentation index, see [llms.txt](https://lethium.gitbook.io/lethium-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lethium.gitbook.io/lethium-docs/placeholders/progress.md).

# Progress placeholders

Profile Level, Rebirth, clan, idle, leaderboard and HUD toggle placeholders.

### Profile Level

| Placeholder                          | Returns                            |
| ------------------------------------ | ---------------------------------- |
| `%clickem_profile_level%`            | Level                              |
| `%clickem_profile_max_level%`        | Maximum level                      |
| `%clickem_profile_xp%`               | Total lifetime Profile XP          |
| `%clickem_profile_xp_into_level%`    | XP earned inside the current level |
| `%clickem_profile_xp_needed%`        | XP needed for the next level       |
| `%clickem_profile_progress_percent%` | `0` to `100` toward the next level |

### Rebirth

| Placeholder                             | Returns                                 |
| --------------------------------------- | --------------------------------------- |
| `%clickem_rebirth_count%`               | Rebirths so far                         |
| `%clickem_rebirth_required_currency%`   | Coins needed for the next rebirth       |
| `%clickem_rebirth_required_essence%`    | Essence needed (0 in the default setup) |
| `%clickem_rebirth_required_kills%`      | Zone kills needed                       |
| `%clickem_rebirth_kill_progress%`       | Zone kills so far                       |
| `%clickem_rebirth_required_boss_kills%` | Boss kills needed                       |
| `%clickem_rebirth_boss_kills%`          | Boss kills so far                       |
| `%clickem_rebirth_boss_name%`           | The boss's name                         |
| `%clickem_rebirth_progress_percent%`    | `0` to `100` overall                    |
| `%clickem_rebirth_blocked_by%`          | What is missing                         |

### Clan

If the player is not in a clan, `in_clan` is `false` and `id`, `name`, `tag`, `leader`, `motd` and `role` return `None`. The others are empty.

| Placeholder                                              | Returns                                         |
| -------------------------------------------------------- | ----------------------------------------------- |
| `%clickem_clan_in_clan%`                                 | `true` or `false`                               |
| `%clickem_clan_id%`, `_name%`, `_tag%`                   | Identity                                        |
| `%clickem_clan_level%`                                   | Clan level                                      |
| `%clickem_clan_xp%`, `_xp_needed%`, `_progress_percent%` | The level track                                 |
| `%clickem_clan_bank%`                                    | Shared bank                                     |
| `%clickem_clan_members_count%`, `_members_cap%`          | Roster vs cap                                   |
| `%clickem_clan_leader%`                                  | Leader's name                                   |
| `%clickem_clan_role%`                                    | The viewer's own role (Member, Officer, Leader) |
| `%clickem_clan_motd%`                                    | Message of the day                              |
| `%clickem_clan_open%`                                    | `true` or `false`                               |

The tag is used in this setup's chat and tab list.

### Idle earnings and the AFK pool

| Placeholder                          | Returns                                           |
| ------------------------------------ | ------------------------------------------------- |
| `%clickem_idle_active%`              | `true` while earning in the AFK pool              |
| `%clickem_idle_payout%`              | Coins per payout in the pool                      |
| `%clickem_idle_payout_formatted%`    | Compact                                           |
| `%clickem_idle_per_hour%`            | Coins per hour                                    |
| `%clickem_idle_per_hour_formatted%`  | Compact                                           |
| `%clickem_idle_next_payout_seconds%` | Seconds until the next payout                     |
| `%clickem_idle_next_reward_seconds%` | Seconds until the next timed reward (the AFK key) |
| `%clickem_idle_next_reward%`         | The same as readable text (for example `12m 30s`) |

### Leaderboards

| Placeholder                                           | Returns                                  |
| ----------------------------------------------------- | ---------------------------------------- |
| `%clickem_leaderboard_<board>_<rank>_name%`           | Player name at that rank                 |
| `%clickem_leaderboard_<board>_<rank>_value%`          | Their value                              |
| `%clickem_leaderboard_first_count%`                   | How many boards the **viewer** is 1st on |
| `%clickem_leaderboard_second_count%`, `_third_count%` | The same for 2nd and 3rd                 |
| `%clickem_leaderboard_podium_count%`                  | Boards where they are in the top 3       |

`<board>` is the lower-case board name, for example `kills`, `rebirths`, `stat_damage`, `profile_level`. See [Leaderboards](/lethium-docs/gameplay/leaderboards.md) for all names. `<rank>` is 1 to `top-size` (10).

Example: `%clickem_leaderboard_kills_1_name%` and `%clickem_leaderboard_kills_1_value%`.

### HUD panel toggles

Per-player choices from `/settings`, as `true` or `false`. They **only report the choice**. Your HUD must use them as a condition.

`%clickem_hud_pets%`, `%clickem_hud_echoes%`, `%clickem_hud_location%`, `%clickem_hud_main%`, `%clickem_hud_abilities%`.


---

# 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://lethium.gitbook.io/lethium-docs/placeholders/progress.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.