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

# Configuration reference

## Configuration layers

`plugins/RegenZone/config.yml` contains global performance settings, selection settings, default arena rules and shared messages. `arena-defaults` is copied when an arena is created. Editing defaults does not change existing arenas.

Each arena has `arenas/<name>.yml`, containing world UUID, inclusive bounds, `settings` and optional `subzones`. Use `/rz set` for live changes. Stop the server before editing arena files directly; restart to load them. `/rz reload` only reloads global configuration and messages.

Settings are validated before being accepted. Use YAML booleans and integers without quotes. Use lists for material filters and a YAML mapping for material delays. Material names must exist in the running server version.

## Global performance

| Key under `performance` | Default | Accepted range / purpose                     |
| ----------------------- | ------: | -------------------------------------------- |
| `blocks-per-tick`       |     800 | 1–100000; shared job-processing count budget |
| `milliseconds-per-tick` |     3.0 | 0.1–40; approximate shared job time budget   |
| `max-blocks-per-arena`  |  500000 | 1–10000000; maximum selected volume          |
| `max-total-blocks`      | 3000000 | At least per-arena maximum, at most 50000000 |
| `max-arenas`            |      32 | 1–1000                                       |

These are resource safeguards, not paid-tier restrictions. Increasing them increases potential memory use and workload. There is one shared processing queue, not one independent full budget per arena. A synchronous chunk load or a single server API call may exceed the time budget on its own.

## Selection appearance

| Key under `selection` | Default         | Purpose                                            |
| --------------------- | --------------- | -------------------------------------------------- |
| `enabled`             | true            | Enable the private edge outline                    |
| `rgb`                 | `'190,165,100'` | One RGB color, each component 0–255                |
| `particle-size`       | 0.7             | Dust size; clamped to 0.1–4                        |
| `spacing`             | 1.0             | Requested edge-point spacing; subject to point cap |
| `max-points`          | 240             | Point cap per outline; clamped to 8–1000           |
| `view-distance`       | 48              | Viewer distance; clamped to 1–128                  |
| `refresh-ticks`       | 10              | Refresh interval; minimum 2 ticks                  |
| `expire-seconds`      | 180             | Visibility lifetime; minimum 10 seconds            |

Invalid color configuration disables the visualization and logs the reason. Correct the value and run `/rz reload`. Selection itself remains available.

## Arena timing and automation

| Setting                  | Default  | Purpose                                                    |
| ------------------------ | -------- | ---------------------------------------------------------- |
| `enabled`                | true     | Schedule automatic work; manual commands remain available  |
| `mode`                   | interval | `interval`, `changes`, `block`, `inactivity`               |
| `interval-seconds`       | 300      | Interval mode timing; 10–31536000                          |
| `warning-seconds`        | 10       | Interval advance warning; 0 disables; less than interval   |
| `block-delay-seconds`    | 10       | Individual base delay; 1–31536000                          |
| `break-delay-seconds`    | -1       | Break/other-event delay; -1 inherits, otherwise 1–31536000 |
| `place-delay-seconds`    | -1       | Placement delay; -1 inherits, otherwise 1–31536000         |
| `material-delays`        | `{}`     | Material name to delay in seconds, each 1–31536000         |
| `inactivity-seconds`     | 20       | Quiet period for inactivity mode; 1–31536000               |
| `wait-until-empty`       | true     | Wait before capture, full or grouped restoration           |
| `block-wait-until-empty` | false    | Wait before individual restoration                         |
| `empty-seconds`          | 5        | Continuous empty duration; 0–3600                          |
| `load-unloaded-chunks`   | true     | Gradually load existing chunks when needed                 |

All players, including spectators, count toward arena occupancy. The plugin does not teleport or eject players. Terrain must already be generated; it will not generate missing terrain to complete an arena.

## Blocks and tracking

| Setting                 | Default              | Purpose                                                                                   |
| ----------------------- | -------------------- | ----------------------------------------------------------------------------------------- |
| `restore-air`           | true                 | Replace current blocks with saved air                                                     |
| `include-materials`     | `[]`                 | Empty allows all ordinary materials; otherwise both original and current must be included |
| `exclude-materials`     | `[BEDROCK, BARRIER]` | Skip when either original or current matches                                              |
| `track-placements`      | true                 | Observe player placements for selective modes                                             |
| `track-explosions`      | true                 | Observe explosion block lists for selective modes                                         |
| `track-natural-changes` | false                | Observe supported natural change events                                                   |
| `protect-when-idle`     | false                | Protect against covered event changes outside full jobs too                               |
| `protect-boundary`      | true                 | Block covered piston/fluid crossings at outer arena boundaries                            |
| `protect-player-floor`  | true                 | Postpone removing the block below a player's feet                                         |
| `drop-items`            | false                | Allow normal direct player-break item drops                                               |
| `drop-experience`       | false                | Allow normal direct player-break experience                                               |

Drop controls apply inside saved arenas at non-tile snapshot positions. They are independent of regeneration filters. They do not remove already dropped items, container contents, explosion loot, indirect physics drops or loot created separately by other plugins. Use an appropriate protection or economy policy if your server requires stronger resource-abuse prevention.

Examples:

```
/rz set practice restore-air true
/rz set practice exclude-materials BEDROCK,BARRIER,OBSIDIAN
/rz set practice include-materials STONE,DIRT,AIR,CAVE_AIR,VOID_AIR
/rz set practice include-materials -
/rz set practice drop-items false
/rz set practice drop-experience false
```

`-` clears a material list. Lists in commands use commas without spaces. Excluding `AIR` also excludes current holes of that material, which can prevent broken blocks from being repaired. If inclusion is restrictive, include air to allow repairing holes.

## Notifications

| Setting                | Default      | Purpose                                                 |
| ---------------------- | ------------ | ------------------------------------------------------- |
| `announce`             | true         | Master switch for nearby automatic announcements        |
| `notification-channel` | chat         | `chat`, `actionbar`, `none`                             |
| `warning-message`      | empty string | Arena-specific interval warning; empty uses global text |
| `restored-message`     | empty string | Arena-specific completion text; empty uses global text  |

Announcements target players in the same world within a 32-block X/Z margin around the arena. Per-block jobs remain silent. Administrative command feedback still goes to the command sender.

Placeholders: `{arena}` in both texts, `{seconds}` in warnings, `{changed}` in completion messages. Standard `&` color codes are supported.

```
/rz set practice notification-channel actionbar
/rz set practice warning-message &7Arena {arena} restores in {seconds}s.
/rz set practice restored-message &7Arena ready. {changed} blocks restored.
```

The shared `messages` section contains `prefix`, `no-permission`, `player-only`, `wand`, `point`, `selected`, `busy`, `queued`, `saved`, `restored`, `warning` and `failed`. Not every administrative diagnostic is a configurable message in this release. Existing Spanish command names and diagnostics remain for backward compatibility; the documentation and new administrative menu explanations are in English.

## Example arena settings

This is the `settings` section of an existing arena file, not an entire arena file:

```yaml
settings:
  mode: block
  enabled: true
  interval-seconds: 300
  warning-seconds: 10
  block-delay-seconds: 10
  break-delay-seconds: 5
  place-delay-seconds: 25
  material-delays:
    WHITE_WOOL: 3
    STONE: 12
  inactivity-seconds: 20
  wait-until-empty: true
  block-wait-until-empty: false
  empty-seconds: 5
  load-unloaded-chunks: true
  restore-air: true
  include-materials: []
  exclude-materials: [BEDROCK, BARRIER]
  track-placements: true
  track-explosions: true
  track-natural-changes: false
  protect-when-idle: false
  protect-boundary: true
  protect-player-floor: true
  drop-items: false
  drop-experience: false
  announce: true
  notification-channel: chat
  warning-message: ''
  restored-message: ''
```


---

# 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://matt-creppet.gitbook.io/matt-docs/configuration.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.