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

# README

HeadBlocks is a Minecraft plugin that keeps your players engaged and entertained. Hide heads throughout your world, and players must find them to earn rewards.

## Quick Start

New to HeadBlocks? Get up and running in under a minute:

1. [Install the plugin](/headblocks/getting-started/installation.md)
2. [Place your first heads](/headblocks/getting-started/first-steps.md)
3. [Customize the experience](https://github.com/AerWyn81/HeadBlocks/blob/master/docs/configuration/overview.md)

## What Can You Do?

### For Server Admins

* **Create treasure hunts** — place unlimited heads across your world with custom textures
* **Reward players** — configure commands, messages, and milestone rewards when heads are found
* **Multi-Hunt system** — create independent hunts with their own heads, progression, rewards, and [behaviors](/headblocks/other-files/hunts.md#behaviors)
* **Hunt behaviors** — free, ordered, scheduled (date-based), timed (race mode with pressure plate), or zone (confine players to a cuboid or WorldGuard region)
* **Customize everything** — particles, holograms, sounds, fireworks, titles, and more
* **Scale up** — works on single servers or multi-server networks with [Redis + MySQL](/headblocks/configuration-config.yml/storage.md)

### For Developers

* [Java API](/headblocks/developers/api.md) with events for heads and hunts (with cancellable hunt events)
* [PlaceholderAPI](/headblocks/reference/placeholders.md) integration with per-hunt placeholders

## Need Help?

* Browse the [Commands Reference](/headblocks/getting-started/commands.md) for all available commands
* Check the [Configuration Guide](https://github.com/AerWyn81/HeadBlocks/blob/master/docs/configuration/overview.md) for setup details
* Join the [Discord](https://discord.gg/f3d848XsQt) for community support
* Report bugs on [GitHub](https://github.com/AerWyn81/HeadBlocks/issues)


---

# 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://aerwyn81.gitbook.io/headblocks/readme.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.