Skip to content

Home

Jump to bottom
Mardssss edited this page Sep 10, 2024 · 14 revisions

Overview

The AreaRegen Plugin is a Minecraft plugin that allows for customizable regeneration of entire worlds or specific regions within a world. This plugin provides fine-grained control over regeneration settings, including regeneration time and delay, and supports multiple worlds and regions.

Requirements

The Area Regen plugin is a standalone plugin and does not require any additional plugins to function. However, if you want to take advantage of region-based regeneration, you will need to install WorldGuard.

You can download WorldGuard Here.

Features

1. World Regeneration

The plugin can regenerate entire worlds or specific regions within a world.

2. Customizable Regeneration Time

The regeneration time (in ticks) can be set for each world and region, allowing for fine-grained control over the regeneration process.

3. Customizable Delay

The delay (in ticks) before starting the regeneration task can be set for each world and region, allowing for flexibility in scheduling regeneration tasks.

4. Region-Based Regeneration

The plugin supports regenerating specific regions within a world, which requires World Guard to be installed.

5. Multiple World Support

The plugin can handle multiple worlds, each with its own regeneration settings.

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.
      • region: The region 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 region.
        • delay: Sets the delay (in ticks) before starting the regeneration task for the region.

Examples

Regenerating an Entire World

Replace my_world with your world name. If enabled set to false the world will not regenerate.

my_world:
  enabled: true
  regen-time: 10
  delay: 2

Regenerating Specific Regions within a World

Replace my_world with your world name. If my_world enabled set to false both regions and the world will not regenerate Replace region1 with your worldguard region name. Replace region2 with your worldguard region name. If enabled set to false the region will not regenerate.

my_world:
  enabled: true
  regions:
    region1:
      enabled: true
      regen-time: 5
      delay: 1
    region2:
      enabled: true
      regen-time: 5
      delay: 1

Clone this wiki locally