> For the complete documentation index, see [llms.txt](https://docs.cheddah-development.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cheddah-development.net/plugin-documentaion/cozy-claims/administration/config.yml.md).

# config.yml

The default file is created at `plugins/CozyClaims/config.yml`. Run `/claimsadmin reload` after normal changes.

### General settings

#### `disabled-worlds`

A case-insensitive list of world names where CozyClaims is inactive. No claims can be created or changed there, and existing claims behave like wilderness without being deleted.

```yaml
disabled-worlds:
  - resource_world
  - minigames
```

#### `settings.trust-input-timeout-seconds`

How long a player has to enter a member name in chat. Values are clamped from 1 to 600 seconds.

`settings.require-griefprevention` only applies to legacy-authority installations.

### Claim blocks

```yaml
claim-blocks:
  initial-accrued-blocks: 100
  accrual:
    blocks-per-hour: 100
    maximum-accrued-blocks: 80000
```

* `initial-accrued-blocks`: starting accrued balance for a new player
* `blocks-per-hour`: online-time earning rate
* `maximum-accrued-blocks`: cap for naturally accrued blocks; bonus blocks are separate
* `import-legacy-config-on-cutover`: imports compatible legacy accrual settings during cutover

### Claim tool

`claim-tool.material` controls the item given by the menu's Claim Tool button. `give-button-enabled` hides or shows that button. `allow-duplicate` controls whether a player can receive another copy while already carrying the configured material.

Claim Mode itself does not require the tool.

### Teleportation

* `enabled`: master switch
* `cooldown-seconds`: per-player delay; `0` disables it
* `require-claim-access`: require ownership or claim access
* `allow-cross-world`: permit teleports between worlds

### Borders

The `borders.blocks` section controls client-side fake block markers. The real world is never modified. Edge/corner materials must be valid block materials.

The `borders.particle` section adds particle lines and corner pillars. Limits and spacing help control the client and server cost for large claims.

`duration-seconds` is clamped to 15–20 seconds.

### Admin menus

The `admin` section controls the player browser, offline-player visibility, claim counts, sorting, inspection input, and admin teleport/border buttons. Permission checks still apply when a button is enabled.

### Bans

The `bans` section controls native claim-ban management, offline targets, chat-input timeout, and repeated denial-message cooldown.

The `banfromclaim` section is only for legacy-authority compatibility. It is ignored during normal native operation.

### Search, sort, and rename

* `search.enabled`, timeout, and maximum query length control claim search.
* `sort.default` accepts `NAME`, `WORLD`, `NEWEST`, or `OLDEST`.
* `rename` controls availability, name length, color support, and input timeout.

When `rename.allow-colors` is false, MiniMessage and legacy color codes are stripped before storage.

### Claim icons

* `enabled`: show the icon feature
* `default-material`: default Bukkit material, or an Oraxen item with a vanilla fallback
* `allow-any-inventory-item`: permit eligible inventory items outside the curated picker
* `selection-timeout-seconds`: inventory-selection timeout
* `blocked-materials`: materials that can never be used or displayed
* `allowed-materials`: curated picker contents

Only the Bukkit material is stored for player-selected icons. Item names, lore, enchantments, custom model data, and Oraxen IDs are not copied from player inventory items.

### GUI and sounds

`gui.title` and `gui.tutorial-title` provide basic title fallbacks. Most detailed UI text is in `messages.yml`.

`sounds.enabled` is the global switch. Each sound action has its own enabled flag, registry key, volume, and pitch. Volume and pitch are clamped from 0.0 to 2.0. Invalid names are logged and skipped.

### Migration and engine sections

`migration`, `shadow`, and the legacy values under `engine` support upgrades from GriefPrevention-based installations. A fresh installation starts with native authority and normally should not change these values.

{% hint style="warning" %}
Do not change `engine.claim-authority` to force a migration. Use the validated migration and cutover commands described in Migrating from GriefPrevention.
{% endhint %}

### Claim Mode timeout

`claiming.timeout-seconds` controls how long an inactive Claim Mode session remains active.


---

# 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://docs.cheddah-development.net/plugin-documentaion/cozy-claims/administration/config.yml.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.
