> 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/core/pickaxe.md).

# The Pickaxe

The prison pickaxe is the heart of the plugin. Players mine with it, it carries their [enchants](/p/pinnaprison/core/enchants.md) and [crystals](/p/pinnaprison/tools-and-items/crystals.md), it can be re-skinned with [pickaxe skins](/p/pinnaprison/core/pickaxe/pickaxe-skins.md), and right-clicking it opens the enchant menu. It is configured in `pickaxe/config.yml`.

```yaml
hotbar-slot: 0

enchant-format: ' &b| {prim-color}{name} {sec-color}{level} {prestige-stars}'
no-enchants-format: ' &b| &cNo enchants!'
enchant-max-level-format: '&lMAX'
update-pickaxe-interval: 4 # in seconds

gui: 'token-enchants'

efficiency: 1000

item:
  material: DIAMOND_PICKAXE
  name: '&7&lPrison &b&lPickaxe'
  lore:
    - '&7Right click your pickaxe in hand to access your enchants'
    - '&b&lLeveling'
    - ' &b| &7Level: &b%pinnaprison_leveling_balance_pickaxelevel_formatted%'
    - ' &b| &7Experience: &a%pinnaprison_leveling_bar_pickaxelevel% &a%pinnaprison_leveling_progress_pickaxelevel%%'
    - '&b&lEnchants &3({total-enchants})'
    - '{enchants-format}'
    - '&b&lCrystals &3({total-crystals}/{crystal-slots})'
    - '{crystals-format}'
```

## Settings

| Key                        | Description                                                                                                                                                                         |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `hotbar-slot`              | The hotbar slot (0–8) the pickaxe is locked to.                                                                                                                                     |
| `enchant-format`           | How each enchant line renders in the pickaxe lore (`{enchants-format}`). Placeholders: `{prim-color}`, `{sec-color}`, `{name}`, `{level}`, `{prestige-stars}`.                      |
| `no-enchants-format`       | Shown by `{enchants-format}` when the player has no enchants.                                                                                                                       |
| `enchant-max-level-format` | Replaces the level number when an enchant is maxed.                                                                                                                                 |
| `update-pickaxe-interval`  | How often (seconds) the pickaxe item refreshes in the player's hand.                                                                                                                |
| `gui`                      | The enchant menu opened when the player right-clicks the pickaxe (a file in `guis/`).                                                                                               |
| `efficiency`               | The mining efficiency applied to the pickaxe (controls block-break speed).                                                                                                          |
| `item`                     | The pickaxe item itself — material, name and lore. Use `{prim-color}`/`{sec-color}`/`{skin-material}` to inherit the equipped [skin](/p/pinnaprison/core/pickaxe/pickaxe-skins.md). |
| `skins`                    | The pickaxe-skin system: upgrade order, skins GUI and status text. See [Pickaxe Skins](/p/pinnaprison/core/pickaxe/pickaxe-skins.md).                                               |

## Pickaxe lore placeholders

The pickaxe lore can use any [placeholder](/p/pinnaprison/reference/placeholders.md), plus these special tokens that are built from the player's pickaxe state:

| Placeholder         | Meaning                                                                  |
| ------------------- | ------------------------------------------------------------------------ |
| `{enchants-format}` | The list of the player's enchants (each rendered with `enchant-format`). |
| `{total-enchants}`  | How many enchants the player owns.                                       |
| `{crystals-format}` | The list of applied crystals.                                            |
| `{total-crystals}`  | How many crystals are applied.                                           |
| `{crystal-slots}`   | The player's crystal slot capacity.                                      |

## Behaviour

* **Right-click** the pickaxe → opens the enchant menu (`gui`).
* The pickaxe is **soulbound** to its hotbar slot and cannot be dropped, moved or placed.
* Enchants, crystals and leveling shown in the lore update automatically every `update-pickaxe-interval` seconds.

## Giving a pickaxe

* Players normally receive the pickaxe automatically.
* Admins can (re)give it with `/pinna givepickaxe <player>`.


---

# 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/core/pickaxe.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.