# Config

The plugin can managed through 3 configuration files:  `config.yml`, `messages.yml` and `settings.yml`. You can also edit the majority of these settings through an in-game menu editor by simply typing `/itemblacklist`. Below is an explanation of the default settings (these files are generated by the plugin once you load it for the first time or delete the existing file)

### Example config.yml

```yaml
# =======================================================
# AliienItemBlacklist - Config
# =======================================================
# List of blacklisted items (make sure they are in caps)
blacklisted-items:
  - BEDROCK
  - BARRIER

# DO NOT under any circumstance touch this unless you are told to by the official support
config-version: 1
```

### Example messages.yml

```yml
# =======================================================
# AliienItemBlacklist - Messages
# =======================================================
# The prefix of the messages (set as "" if you don't want to use this)
prefix: "<dark_purple><bold>ITEM</dark_purple><light_purple><bold>BLACKLIST</bold></light_purple> <dark_gray>»</dark_gray> "
# If a player does not have permission to execute a certain action
no-permission: "<red>You do not have permission to perform this command!"
# If the plugin is successfully reloaded
reload: "<green>AliienItemBlacklist has been reloaded successfully!"
# If there is an error while reloading the config
fail-reload: "<red>There was an error while reloading AliienItemBlacklist! Check console."
# Staff alert message if there was a blacklisted item in circulation
alert: "<red><bold>THE PLAYER %player% HAD A BLACKLISTED ITEM! (%item%)"
# If you are not holding an item while trying to edit the blacklist through the in-game editor
not-holding-item: "<red>You must be holding an item to do this!"
# Successfully add an item to the blacklist through the in-game editor
added-item-to-blacklist: "<green>The item %item% has successfully been added to the blacklist!"
# Tried to add an item to the blacklist through the in-game editor, but it was already there
item-already-blacklisted: "<red>The item %item% is already blacklisted!"
# If there is a new plugin version available
new-version: "<green>A new AliienItemBlacklist version is now available!"

# DO NOT under any circumstance touch this unless you are told to by the official support
config-version: 1
```

### Example settings.yml

```yml
# =======================================================
# AliienItemBlacklist - Settings
# =======================================================
# Should players with the aliien.itemblacklist.alert permission receive an alert when a player
# tries to interact with a blacklisted item?
show-alerts: true
# If true, NO ONE can use blacklisted items, not even OPs or players with the bypass permission.
# Highly recommended if there is an exploit currently going around.
strict-mode: false
# If true, it will create/update the logs.txt file every time a player tries to interact with a
# blacklisted item in any way (changing this requires a reboot)
enable-logging: true
# If true, players with the aliien.itemblacklist.version-notify permissions will be
# notified every time there is a new plugin update (changing this requires a reboot)
check-for-updates: true

# Sound Configuration
# Format: SOUND_NAME:VOLUME:PITCH
# You can use standard Bukkit sounds (e.g., UI_BUTTON_CLICK)
# or custom Resource Pack sounds (e.g., aliien.ui.click).
# Set to "none" to disable a specific sound.
sounds:
  enabled: true # If this is set to false, you can ignore the rest
  click: "UI_BUTTON_CLICK:0.5:1.0"
  success: "ENTITY_PLAYER_LEVELUP:0.5:2.0"
  error: "ENTITY_VILLAGER_NO:0.8:1.0"
  alert: "BLOCK_ANVIL_LAND:0.8:1.0"

# A list of worlds where the item blacklist is completely ignored.
# Players can use any blacklisted items in these worlds.
disabled-worlds:
  - "example_world"

# DO NOT under any circumstance touch this unless you are told to by the official support
config-version: 1
```


---

# Agent Instructions: 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:

```
GET https://aliien.gitbook.io/aliien-docs/aliienitemblacklist/config.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.