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

# Placeholders (PlaceholderAPI)

This page covers both built-in placeholders and the PlaceholderAPI expansion.

### Internal placeholders

These placeholders work inside `menu.yml` text without requiring PlaceholderAPI.

| Placeholder        | Replaces with                         |
| ------------------ | ------------------------------------- |
| `%player%`         | Player name                           |
| `%tier%`           | Current tier or `Global config`       |
| `%size%`           | Mine size like `10x10x10`             |
| `%reset_time%`     | Reset time in seconds                 |
| `%visits_allowed%` | `Open` or `Closed`                    |
| `%threshold%`      | Current threshold                     |
| `%broken%`         | Broken blocks                         |
| `%total%`          | Total blocks                          |
| `%percent%`        | Completion percentage                 |
| `%status_lore%`    | `Status: Active` or `Status: Pending` |
| `%action_lore%`    | Conditional action text               |
| `%progress_lore%`  | Progress line                         |

### PlaceholderAPI

If PlaceholderAPI is installed, the plugin automatically registers the `jpprivatemines` expansion.

### Usage

```
%jpprivatemines_<placeholder>%
```

### Available placeholders

| Placeholder                       | Returns                      |
| --------------------------------- | ---------------------------- |
| `%jpprivatemines_has_mine%`       | `true` or `false`            |
| `%jpprivatemines_status%`         | `Active` or `Pending`        |
| `%jpprivatemines_tier%`           | Tier name or `Global config` |
| `%jpprivatemines_size%`           | Mine size like `10x10x10`    |
| `%jpprivatemines_reset_time%`     | Auto-reset time in seconds   |
| `%jpprivatemines_visits_allowed%` | `Open` or `Closed`           |
| `%jpprivatemines_threshold%`      | Current threshold            |
| `%jpprivatemines_broken%`         | Broken blocks                |
| `%jpprivatemines_total%`          | Total blocks                 |
| `%jpprivatemines_percent%`        | Completed percentage         |


---

# 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://jpprison.gitbook.io/jpprison-docs/mines/commands-and-permissions/placeholders-placeholderapi.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.