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

# Installation

## Requirements

|           |                                |
| --------- | ------------------------------ |
| Server    | Paper, Folia, Purpur or Spigot |
| Minecraft | 1.17 to 26.3                   |
| Java      | 16 or newer                    |

The same jar runs on every supported version. Features that need a newer version, such as the crafter from 1.21, switch on by themselves when the server has them. On Paper before 1.20, ItemBlocker uses the Bukkit scheduler and the Spigot armor checks.

## Install

1. Download `ItemBlocker-<version>.jar` from [Modrinth](https://modrinth.com/plugin/itemblocker), [Hangar](https://hangar.papermc.io/kuqk/ItemBlocker) or the [GitHub releases](https://github.com/kuqk/ItemBlocker/releases).
2. Put it in your server's `plugins/` folder.
3. Start or restart the server.

ItemBlocker creates `plugins/ItemBlocker/` with:

| File              | Contains                                                                                                 |
| ----------------- | -------------------------------------------------------------------------------------------------------- |
| `config.yml`      | Language, message cooldown, bypass and log settings. See [config.yml](/itemblocker/reference/config.md). |
| `rules.yml`       | All presets and rules. See [rules.yml](/itemblocker/reference/rules-file.md).                            |
| `lang/`           | One message file per language. See [Messages and languages](/itemblocker/reference/messages.md).         |
| `logs/`           | One file per day with every blocked action, once something was blocked.                                  |
| `confiscated.yml` | Items taken away by scans or enchantment rules, once there are any.                                      |

## Optional plugins

ItemBlocker works on its own. When these plugins are installed, it hooks into them:

* [WorldGuard](/itemblocker/integrations/worldguard.md): limit presets to regions.
* [PlaceholderAPI](/itemblocker/integrations/placeholderapi.md): use its placeholders in messages.

## Updating

Replace the jar and restart. Your `rules.yml`, `config.yml` and message files are kept. New settings and messages fall back to their defaults until you add them. Read the [changelog](https://github.com/kuqk/ItemBlocker/blob/main/CHANGELOG.md) for changes in behaviour.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://opuszek.gitbook.io/itemblocker/getting-started/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.