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

# config.yml

`plugins/ItemBlocker/config.yml` holds the settings. Rules live in [rules.yml](/itemblocker/reference/rules-file.md). Run `/ib reload` after editing it.

```yaml
config-version: 2

# Language of plugin messages: en, pl, de, es, fr, it, or your own file in lang/
language: en

messages:
  # Minimum time between two restriction messages to the same player, in milliseconds.
  cooldown-ms: 1000

bypass:
  # Players with itemblocker.bypass ignore every restriction.
  enabled: true
  # Players with itemblocker.bypass.<action> ignore restrictions for that action.
  per-action: true

log:
  # Write every blocked action to logs/<date>.log.
  enabled: true
  discord:
    # Discord webhook that gets an alert for every blocked action. Empty turns it off.
    webhook: ""
    # Minimum time between two alerts about the same player, action and item, in seconds.
    cooldown-seconds: 60
```

| Setting                        | Default | Description                                                                       |
| ------------------------------ | ------- | --------------------------------------------------------------------------------- |
| `language`                     | `en`    | The [message file](/itemblocker/reference/messages.md) to use                     |
| `messages.cooldown-ms`         | `1000`  | Keeps holding right click from flooding the chat with messages                    |
| `bypass.enabled`               | `true`  | Whether the global `itemblocker.bypass` permission works                          |
| `bypass.per-action`            | `true`  | Whether `itemblocker.bypass.<action>` and similar work                            |
| `log.enabled`                  | `true`  | Whether blocked actions are written to [log files](/itemblocker/features/logs.md) |
| `log.discord.webhook`          | empty   | A Discord webhook URL for [alerts](/itemblocker/features/logs.md#discord-alerts)  |
| `log.discord.cooldown-seconds` | `60`    | Minimum time between two alerts about the same player, action and item            |

Settings missing from the file use their default.

The two bypass switches are independent. To test rules as an operator, set both `bypass.enabled: false` and `bypass.per-action: false`, then run `/ib reload`. Operators inherit the per-action permissions from `itemblocker.bypass`, so disabling only the global check is not enough.


---

# 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/reference/config.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.