# Placeholders

## EnchantCore's Placeholders

These placeholders can be used in any plugin that supports PlaceholderAPI (e.g., scoreboards, chat formats, GUIs, holograms) to display dynamic information about a player's EnchantCore pickaxe and stats.

**Identifier:** `enchantcore`

### Pickaxe Stat Placeholders

These relate to the player's main EnchantCore pickaxe.

* **`%enchantcore_level%`**
  * **Description:** Displays the current level of the player's EnchantCore pickaxe.
  * **Example Output:** `52`
* **`%enchantcore_blocks_mined%`**
  * **Description:** Shows the total number of blocks the player has mined with their EnchantCore pickaxe, formatted with commas.
  * **Example Output:** `1,234,567`
* **`%enchantcore_blocks_required%`**
  * **Description:** Displays the total number of blocks needed to reach the *next* pickaxe level, formatted with commas. Shows "Max" if the pickaxe is at its maximum level.
  * **Example Output:** `250,000` or `Max`
* **`%enchantcore_progress%`** (Replaces `pickaxe_blocks_progress`)
  * **Description:** Shows the number of blocks mined *within the current level's progress*, formatted with commas. Displays "Max" if the pickaxe is at max level.
  * **Example Output:** `15,300`
* **`%enchantcore_needed%`** (Replaces `pickaxe_blocks_needed_for_level`)
  * **Description:** Shows the total number of blocks needed to complete the current pickaxe level, formatted with commas. Displays "Max" if the pickaxe is at max level or if the next level is somehow unachievable.
  * **Example Output:** `50,000`
* **`%enchantcore_progress_percentage%`**
  * **Description:** Shows the current pickaxe level progress as a percentage, formatted to one decimal place (e.g., "30.6"). Displays "100.0" if maxed.
  * **Example Output:** `30.6` or `100.0`
* **`%enchantcore_max_pickaxe_level%`**
  * **Description:** Displays the maximum possible level for EnchantCore pickaxes as configured in `pickaxe.yml`. Shows "Unlimited" if set to 0 or negative.
  * **Example Output:** `1000` or `Unlimited`
* **`%enchantcore_pickaxe_enchants_count%`**
  * **Description:** Displays the number of active EnchantCore enchantments currently on the player's pickaxe. Requires the player to be online and holding the pickaxe.
  * **Example Output:** `7`

### Player Data & Settings Placeholders

These relate to the player's general EnchantCore data.

* **`%enchantcore_tokens_raw%`**
  * **Description:** Displays the player's raw token balance as a number.
  * **Example Output:** `15270`
* **`%enchantcore_tokens_formatted%`**
  * **Description:** Displays the player's token balance formatted with suffixes (K, M, B, T) for large numbers (e.g., 1.2K, 5.5M).
  * **Example Output:** `15.3K` or `2.1M`
* **`%enchantcore_tokens_comma%`**
  * **Description:** Displays the player's token balance formatted with commas.
  * **Example Output:** `15,270`
* **`%enchantcore_messages_enabled_tf%`**
  * **Description:** Returns `true` or `false` based on whether the player has enchantment messages enabled.
  * **Example Output:** `true`
* **`%enchantcore_sounds_enabled_tf%`**
  * **Description:** Returns `true` or `false` based on whether the player has enchantment sounds enabled.
  * **Example Output:** `false`
* **`%enchantcore_messages_enabled_status%`**
  * **Description:** Returns "Enabled" or "Disabled" (or your configured message from `messages.yml`) for enchantment messages.
  * **Example Output:** `Enabled`
* **`%enchantcore_sounds_enabled_status%`**
  * **Description:** Returns "Enabled" or "Disabled" (or your configured message) for enchantment sounds.
  * **Example Output:** `Disabled`

### Booster Placeholders

These relate to the "BlockBooster" enchantment status for the player.

* **`%enchantcore_blockbooster_active_tf%`**
  * **Description:** Returns `true` if the BlockBooster is currently active for the player, `false` otherwise.
  * **Example Output:** `true`
* **`%enchantcore_blockbooster_active_status%`**
  * **Description:** Returns "Active" or "Inactive" (or your configured message) for the BlockBooster status.
  * **Example Output:** `Active`
* **`%enchantcore_blockbooster_multiplier%`**
  * **Description:** Displays the current BlockBooster multiplier (e.g., "x1.5"). Shows "x1.0" if inactive.
  * **Example Output:** `x1.5`
* **`%enchantcore_blockbooster_time_remaining%`**
  * **Description:** Shows the remaining duration of the BlockBooster in seconds.
  * **Example Output:** `25`
* **`%enchantcore_blockbooster_time_formatted%`**
  * **Description:** Shows the remaining duration of the BlockBooster in a formatted way (e.g., "1h 5m 10s", "30m 5s", "45s").
  * **Example Output:** `1m 15s`

### Dynamic Enchantment Level Placeholders

These allow you to display the current level and max level of any specific enchantment configured in your `enchants.yml`. Replace `<enchant_raw_name>` with the actual `RawName` of the enchantment (e.g., `efficiency`, `explosive`, `my_custom_aoe`).

* **`%enchantcore_enchant_level_<enchant_raw_name>%`**
  * **Description:** Displays the current level of the specified enchantment on the player's pickaxe. Requires player to be online and holding the pickaxe.
  * **Example (for `explosive`):** `%enchantcore_enchant_level_explosive%` -> `12`
* **`%enchantcore_enchant_max_level_<enchant_raw_name>%`**
  * **Description:** Displays the maximum configured level for the specified enchantment.
  * **Example (for `explosive`):** `%enchantcore_enchant_max_level_explosive%` -> `20`

***

**Note:** For placeholders that require the player to be online and holding the pickaxe (like `%enchantcore_pickaxe_enchants_count%` and `%enchantcore_enchant_level_<key>%`), they will typically return "0" or a default value if these conditions are not met.


---

# Agent Instructions: 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:

```
GET https://coziest-room.gitbook.io/coziest-docs/enchantcore/placeholders.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.