Skip to content

Configuration

Jump to bottom
Mardssss edited this page May 11, 2025 · 7 revisions

Configuration

The plugin uses a YAML configuration file to define regeneration settings for multiple worlds and regions. The configuration file consists of the following sections:

Debug

  • enabled: Enables or disables debug mode.

Worlds

  • world: The world name with its own regeneration settings.
    • enabled: Set to true/false to enable/disable this world from regeneration
    • regen-time: Sets the regeneration time (in ticks) for the entire world.
    • delay: Sets the delay (in ticks) before starting the regeneration task for the entire world.
    • regions: Defines regions within the world with their own regeneration settings.

Regions

  • region: The region name with its own regeneration settings.
    • enabled: Set to true/false to enable/disable this region from regeneration
    • regen-time: Sets the regeneration time (in ticks) for the region.
    • delay: Sets the delay (in ticks) before starting the regeneration task for the region.

Blacklist and Whitelist

  • blacklisted-blocks:: A list of blocks to exclude from the regeneration process.
  • whitelisted-blocks:: A list of blocks to include in the regeneration process.

Examples

Regenerating an Entire World

Replace my_world with your world name.

enabled: Set to true to enable regeneration for this world, or false to disable it.

regen-time: Sets the regeneration time (in ticks) for the entire world.

delay: Sets the delay (in ticks) before starting the regeneration task for the entire world.

blacklisted-blocks: A list of blocks to exclude from the regeneration process. In this example, STONE blocks will not be regenerated.

whitelisted-blocks: A list of blocks to include in the regeneration process. In this example, no blocks are whitelisted, so all blocks except STONE will be regenerated.

my_world:
  enabled: true
  regen-time: 10
  delay: 2
  blacklisted-blocks: 
    - STONE
  whitelisted-blocks: {} # Use `{}` if you dont want to include blocks

Regenerating Specific Regions within a World

Replace my_world with your world name.

Replace region1 with your worldguard region name.

Replace region2 with your worldguard region name.

If my_world enabled set to false both regions and the world will not regenerate.

If enabled set to false the region will not regenerate.

regen-time: Sets the regeneration time (in ticks) for the region.

delay: Sets the delay (in ticks) before starting the regeneration task for the region.

blacklisted-blocks: A list of blocks to exclude from the regeneration process.

whitelisted-blocks: A list of blocks to include in the regeneration process. In this example, only STONE blocks will be regenerated.

my_world:
  enabled: true
  regions:
    region1:
      enabled: true
      regen-time: 10
      delay: 2
      blacklisted-blocks: {} # Use `{}` if you dont want to include blocks
      whitelisted-blocks: 
        - STONE
    region2:
      enabled: true
      regen-time: 5
      delay: 1

Clone this wiki locally