> For the complete documentation index, see [llms.txt](https://edseries-plugins.gitbook.io/p/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edseries-plugins.gitbook.io/p/pinnaprison/getting-started/installation.md).

# Installation

## Requirements

| Requirement        | Notes                                                                                        |
| ------------------ | -------------------------------------------------------------------------------------------- |
| **Server**         | Paper (or a Paper fork). Spigot/Bukkit are **not** supported.                                |
| **Versions**       | 1.20.4, 1.21.1, 1.21.4, 1.21.6 – 1.21.8, 1.21.10, 1.21.11, 26.1+                             |
| **Java**           | Java 25 REQUIRED                                                                             |
| **PlaceholderAPI** | **Required.** Almost every menu, item and message uses placeholders.                         |
| **NBTAPI**         | **Required.** Used to tag pickaxes, backpacks, bombs, drills, crystals and abilities.        |
| **Vault**          | **Recommended.** Lets currencies marked `vault-currency: true` integrate with other plugins. |

## Steps

1. Stop your server.
2. Place `PinnaPrison.jar` into `plugins/`.
3. Place `PlaceholderAPI.jar` and `NBTAPI.jar` (and optionally `Vault.jar`) into `plugins/`.
4. Start the server once so all files generate, then stop it.
5. Set up your mine schematic (see [Schematics & Mine Setup](/p/pinnaprison/core/schematics.md)) — this is the only required first-time step.
6. Edit the config files to taste, then start the server.

## File structure

After the first launch you will find these inside `plugins/PinnaPrison/`:

```
config.yml                 # core settings (storage, shared enchant settings, logging)
format.yml                 # number notation (k, M, B…)
messages.yml               # all plugin messages
abilities.yml              # pickaxe abilities
attributes.yml             # pickaxe attributes (rebirth-gated)
autominers.yml             # autominer NPCs + their enchants
autosell.yml               # sell prices + autosell summary
backpacks.yml              # backpack tiers
bombs.yml                  # throwable bombs
boosters.yml               # personal + global boosters
crystals.yml               # pickaxe crystals
drills.yml                 # placeable drills
rebirth.yml                # rebirth + skill tree
display.yml                # action bar / xp bar display
pickaxe/config.yml         # the prison pickaxe item
privatemines/config.yml    # private mine behaviour
privatemines/mines/        # one file per mine type (default.yml)
schematics/                # .pinna schematic files
currencies/                # one file per currency (money.yml, tokens.yml…)
leveling/                  # one file per leveling track (rankup.yml…)
enchants/                  # one file per enchant (jackhammer.yml…)
guis/                      # one file per menu
luckyblocks/               # one file per lucky-block tier
```

## Reloading

Use `/pinna reload` to reload **all** configuration files at runtime — no restart required. The command reports how long the reload took.

{% hint style="warning" %}
Changes to a mine **schematic** or to the mine **world** itself may require players to re-enter their mine (`/mine go`) to see the update.
{% 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:

```
GET https://edseries-plugins.gitbook.io/p/pinnaprison/getting-started/installation.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.