> ## Documentation Index
> Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Placeholders

> All PlaceholderAPI placeholders provided by the Quest Codex Extension.

**Prefix:** `%typewriter_*%`

## Global Placeholders

| Placeholder                      | Returns                                 | Example |
| :------------------------------- | :-------------------------------------- | :------ |
| `%typewriter_total_quests%`      | Total quest count across all categories | `42`    |
| `%typewriter_total_completed%`   | Total completed quests                  | `15`    |
| `%typewriter_total_in_progress%` | Total in-progress quests                | `5`     |
| `%typewriter_total_not_started%` | Total not-started quests                | `22`    |
| `%typewriter_total_progress%`    | Completed/Total formatted               | `15/42` |

## Category Placeholders

*Replace `<name>` with the category identifier (e.g., `main_quests` for a category named `main_quests`).*

| Placeholder                                | Returns                  | Example |
| :----------------------------------------- | :----------------------- | :------ |
| `%typewriter_category_<name>%`             | Total quests in category | `10`    |
| `%typewriter_category_<name>_completed%`   | Completed in category    | `3`     |
| `%typewriter_category_<name>_in_progress%` | In progress in category  | `2`     |
| `%typewriter_category_<name>_not_started%` | Not started in category  | `5`     |
| `%typewriter_category_<name>_progress%`    | Progress formatted       | `3/10`  |

> **Note:** The category name is used **exactly as defined** (case-sensitive). Spaces and special characters are preserved — do not replace spaces with underscores. For a category named `main_quests`, use `%typewriter_category_main_quests_progress%`.

## Template Variables

Variables replaced inside `@Placeholder` fields within entry configurations (not PAPI placeholders):

| Variable      | Available In              | Replaced With                |
| :------------ | :------------------------ | :--------------------------- |
| `{quest}`     | `quest_codex` messages    | The quest's display name     |
| `{completed}` | `categoryProgressMessage` | Number of completed quests   |
| `{total}`     | `categoryProgressMessage` | Total quests in the category |