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

# Introduction

![ItemBlocker](https://raw.githubusercontent.com/kuqk/ItemBlocker/main/.github/banner.png)

ItemBlocker controls what players may do with items on Paper, Folia, Purpur and Spigot servers, Minecraft 1.17 to 26.3.

* **Block items per action**: crafting, picking up, dropping, using, placing, wearing, moving in containers, hoppers, smithing, attacking, breaking, crafters, dispensers, brewing, trading, loot and mob drops.
* **Let players keep an item but not get more of it** with the `obtain` keyword.
* **Block one specific item**, such as a sword from an RPG plugin, by its name, lore, custom model data, plugin data or enchantments.
* **Block whole groups** of items, such as every sword, and allow just a few of them.
* **Limit** how big an item stacks and how many of it a player may carry.
* **Enchantments**: block items above a level, or lower the enchantment, remove it or confiscate the item instead.
* **Potion effects** from a level.
* **Presets** that apply in some worlds or WorldGuard regions only, with ready-made templates for Survival, Lifesteal and PvP.
* **Exceptions**: let a rank ignore one rule or a whole preset.
* **A menu** for nearly everything, commands with tab completion, or one YAML file.
* **Scan** inventories and containers for items that are already there, and remove or confiscate them.
* **Logs** of every blocked action, with optional Discord alerts.
* **An API** for other plugins, with temporary rules and an event that can let actions through.
* Messages in English, Polish, German, Spanish, French and Italian.

## Where to start

* New to ItemBlocker? Read [Installation](/itemblocker/getting-started/installation.md) and the [Quick start](/itemblocker/getting-started/quick-start.md).
* Coming from ItemBlocker 1.x? See [Upgrading from 1.x](/itemblocker/getting-started/upgrading.md).
* Looking for a command or permission? See [Commands](/itemblocker/reference/commands.md) and [Permissions](/itemblocker/reference/permissions.md).
* Writing a plugin? See the [API](/itemblocker/developers/api.md).

## Links

* Downloads: [Modrinth](https://modrinth.com/plugin/itemblocker), [Hangar](https://hangar.papermc.io/kuqk/ItemBlocker), [GitHub releases](https://github.com/kuqk/ItemBlocker/releases)
* Source code and issues: [GitHub](https://github.com/kuqk/ItemBlocker)


---

# 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/readme.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.