Configuration

config.yml holds every server-wide setting. Region specific rules live in regions.yml instead, see Selection and Regions and Block Rules. Every key already carries a plain comment in the file itself, this page mirrors those comments.

config-version is used by the plugin to auto-update the file on upgrades. Do not edit it.

Language

language: en_US

The language file used from the lang folder. Drop your own file in there and write its name here to use a custom translation. See Messages and Language.

Storage

storage:
  type: sqlite
  mysql:
    host: localhost
    port: 3306
    database: regenzones
    username: root
    password: ""
    pool-size: 10

type is sqlite or mysql. SQLite needs no setup. The mysql block only matters when type is mysql. See Storage for detail.

Selection

selection:
  wand-item: GOLDEN_AXE
  wand-name: "<GRADIENT:55FF55>RegenZones Wand</GRADIENT:00AA00>"
  wand-lore:
    - "&aLeft click &fto set position 1"
    - "&aRight click &fto set position 2"
  use-worldedit-selection: true
  max-region-volume: 0

Key	What it controls
`wand-item`	The item given by `/rz wand`
`wand-name`	Name shown on the wand
`wand-lore`	Lore shown on the wand
`use-worldedit-selection`	Use the player's WorldEdit selection when they have no plugin selection
`max-region-volume`	Biggest region allowed, in blocks. `0` means no limit

Defaults

defaults:
  regen-time: 30s
  replace-with: BEDROCK
  drops: true
  experience: true
  collect-to-inventory: false
  delay-placed: false
  harvest: false

Used when a block rule does not set its own value for that field. This is the last stop in the resolution order.

Key	What it controls
`regen-time`	Time before the block comes back. Accepts `30s`, `5m`, `1h` or a plain number of seconds
`replace-with`	Block shown while the original block is away. `AIR` leaves an empty space. A list shows each in turn, see Growth stages
`drops`	Give the normal drops when the block is broken
`experience`	Give the normal experience when the block is broken
`collect-to-inventory`	Give drops straight to the breaking player's inventory instead of dropping them, per region with `/rz collect <name> [on/off]`
`delay-placed`	A handled block a player places inside the region goes straight into its delay state, per region with `/rz placed <name> [on/off]`. See Regeneration Engine
`harvest`	Right-clicking a handled block takes it with its drops and puts its replacement in, per rule with `/rz setharvest`. See Right-click harvest

Sources

sources:
  player-break: true
  explosion: false
  piston: false
  mob: false

What is allowed to start a regeneration cycle. See Protection and Break Sources.

Protection

protection:
  block-break: true
  block-place: true
  piston: true
  explosion: true
  strict-lock: true
  strict-creative-lock: false
  physics: true
  growth: true
  deny-message: ACTION_BAR
  deny-message-cooldown: 3s
  deny-message-grace: 2s
  dig-guard: 2s

What is blocked while a block is mid-regen, and how a player is told. See Protection and Break Sources, including what strict-lock, physics and growth add on top of the four toggles above.

Key	What it controls
`deny-message`	Where "that block is locked" messages go: `ACTION_BAR` above the hotbar, `CHAT`, or `NONE`
`deny-message-cooldown`	Shortest gap between two of those messages to the same player
`deny-message-grace`	No message for this long after a block is taken, `0s` turns it off
`dig-guard`	For this long after a block is taken, and while a held swing continues, its placeholder cannot be broken by anyone, ops included. A crop placeholder shows as empty to the swinging player. `0s` turns it off

Regeneration

regeneration:
  regen-in-unloaded-chunks: true
  blocks-per-tick: 50
  regen-all-on-shutdown: false
  effects:
    enabled: true
    sound: BLOCK_STONE_PLACE
    particle: BLOCK

Key	What it controls
`regen-in-unloaded-chunks`	Bring blocks back even when the chunk is not loaded
`blocks-per-tick`	Blocks brought back per tick. Keeps large regions smooth
`regen-all-on-shutdown`	Bring every waiting block back when the server stops
`effects.enabled`	Play a sound and a particle when a block comes back
`effects.sound`	The sound played
`effects.particle`	The particle played

See Regeneration Engine for how these fit into the full lifecycle.

Farm

farm:
  preserve-farmland: false
  growth-interval: 10s
  growth-amount: 1
  max-volume: 0

Key	What it controls
`preserve-farmland`	Default for whether a region's farmland survives drying out and trampling
`growth-interval`	How often a flagged region's crops advance a growth stage
`growth-amount`	Growth stages added per interval
`max-volume`	Biggest region the farm flag is honoured on, in blocks. `0` means no limit

preserve-farmland here is only the default, /rz farmland <name> [on/off] sets it per region. See Farm Zone.

ItemsAdder

itemsadder:
  enabled: true

Explicit off switch for custom block regen, even when ItemsAdder is installed and detected. See Block Rules.

Reloading

/rz reload reloads config.yml, regions.yml, blocks.yml and the active language file without restarting the server.

On this page