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

# Placeholders

## Placeholders

SimplyMines registers a PlaceholderAPI expansion automatically if PlaceholderAPI is installed and enabled — no extra setup needed. Identifier: `simplymines`.

***

### Per-mine placeholders

Replace `<mine>` with the exact mine name (case-insensitive).

| Placeholder                               | Description                                                  |
| ----------------------------------------- | ------------------------------------------------------------ |
| `%simplymines_<mine>_timeleft%`           | Raw seconds until the next reset (e.g. `142`)                |
| `%simplymines_<mine>_timeleft_formatted%` | Formatted as `mm:ss` (e.g. `02:22`)                          |
| `%simplymines_<mine>_timeleft_hms%`       | Formatted as `h:mm:ss` for longer timers (e.g. `1:02:22`)    |
| `%simplymines_<mine>_resettime%`          | Configured reset interval in seconds                         |
| `%simplymines_<mine>_enabled%`            | Returns `true` or `false`                                    |
| `%simplymines_<mine>_status%`             | Returns `Enabled` or `Disabled`                              |
| `%simplymines_<mine>_warndistance%`       | Configured warning distance in seconds                       |
| `%simplymines_<mine>_blocks_broken%`      | Blocks broken in the mine since the last reset               |
| `%simplymines_<mine>_blocks_count%`       | Total block count of the mine's region                       |
| `%simplymines_<mine>_precent_left%`       | Percentage of the mine still left unmined (2 decimal places) |

***

### Current-mine placeholders

Automatically resolve based on the mine the requesting player is currently standing in.

| Placeholder                                    | Description                                                     |
| ---------------------------------------------- | --------------------------------------------------------------- |
| `%simplymines_currentmine%`                    | Name of the current mine, or `None`                             |
| `%simplymines_currentmine_timeleft%`           | Seconds until that mine resets, or empty if not standing in one |
| `%simplymines_currentmine_timeleft_formatted%` | Same, formatted as `mm:ss`                                      |

***

### Global placeholders

| Placeholder                   | Description                       |
| ----------------------------- | --------------------------------- |
| `%simplymines_count%`         | Total number of mines             |
| `%simplymines_count_enabled%` | Number of currently enabled mines |

{% hint style="warning" %}
`resettime` and the `timeleft*` placeholders read from the mine's Time reset requirement — a mine without a time reset requirement will not resolve these.
{% endhint %}

{% hint style="info" %}
All per-mine placeholders return unresolved (`null`) if the mine name doesn't match any existing mine.
{% endhint %}


---

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