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

# Installation

This guide will walk you through installing HeadHunter on your Minecraft server.

### Prerequisites

{% tabs %}
{% tab title="Server" %}

* Minecraft Server: Paper 1.19+ or Spigot 1.19+ (Paper recommended)
* Java: Version 17 or higher
  {% endtab %}

{% tab title="Required" %}

* Vault [download here](https://www.spigotmc.org/resources/vault.34315/)
  {% endtab %}

{% tab title="Optional" %}

* PlaceholderAPI [download here](https://www.spigotmc.org/resources/placeholderapi.6245/)
* SilkSpawners [download here](https://www.spigotmc.org/resources/silkspawners-versions-1-8-8-1-21-4.60063/)
* RoseStacker  [download here](https://www.spigotmc.org/resources/rosestacker.82729/)
* WildStacker [download here](https://www.spigotmc.org/resources/%E2%9A%A1%EF%B8%8F-wildstacker-%E2%9A%A1%EF%B8%8F-spawners-entities-drops-blocks-%E2%9A%A1%EF%B8%8F-1-21-10-support.87404/)
  {% endtab %}
  {% endtabs %}

### Installation steps

{% stepper %}
{% step %}

### Install dependencies

* Download vault
* Place JAR in your <mark style="color:$success;">plugins/</mark> folder
* Restart your server
* Verify Vault is working: <mark style="color:$success;">/vault-info</mark>
  {% endstep %}

{% step %}

### Install HeadHunter

* Download the latest <mark style="color:$success;">HeadHunter-x.x.x.jar</mark>
* Place in your server's <mark style="color:$success;">plugins/</mark> folder
* Restart your server (don't use <mark style="color:$success;">/reload</mark>)
  {% endstep %}

{% step %}

### Install optional plugins

Spawner plugin is required for [spawner signs](/headhunter/configurations/spawner-shop-signs-config-spawner-shop-signs.yml.md)  to work.

Recommend is RoseStacker but any works fine.
{% endstep %}

{% step %}

### Verify Installation

Run <mark style="color:$success;">/plugins</mark> - HeadHunter should appear in green

Test the main command: <mark style="color:$success;">/hh</mark>
{% endstep %}
{% endstepper %}

### First-Time setup

```
plugins/HeadHunter/
├── custom-enchantments.yml        # Custom enchantments
├── head-storage-blocks.yml        # Stores head storage block locations
├── lang.yml                       # Customizable messages
├── levels.yml                     # Customizable levels
├── level-up-rewards.yml           # Customizable level up rewards
├── main-config.yml                # Main configuration/rules
├── mask-rewards.yml               # Customizable mask rewards
├── masks.yml                      # Customizable wearable masks
├── sell-heads-signs.yml           # Stores sell heads signs locations
├── sounds.yml                     # Customizable sounds
└── spawner-shop-signs.yml         # Stores spawner shop signs locations
```

{% hint style="info" %}
On first run, HeadHunter creates these files. Stop your server, edit the configurations to customize settings, then restart.
{% endhint %}

### Next Steps

<table data-view="cards"><thead><tr><th></th><th data-type="content-ref"></th></tr></thead><tbody><tr><td>⚙️ Configuration</td><td><a href="/pages/FPwUdYNZq0E0S2Q6trZY">/pages/FPwUdYNZq0E0S2Q6trZY</a></td></tr><tr><td>🔒 Permissions</td><td><a href="/pages/vU9eNi7MYA7t9goPWmNb">/pages/vU9eNi7MYA7t9goPWmNb</a></td></tr><tr><td>💻 Commands</td><td><a href="/pages/mkxjkPdbGyXBV76LvpQJ">/pages/mkxjkPdbGyXBV76LvpQJ</a></td></tr></tbody></table>


---

# 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://headhunter-1.gitbook.io/headhunter/installation.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.