Getting started

Basic concepts

This plugin is intended to regenerate single blocks that represent ore nodes. After being mined, they get replaced with an unminable block. After the regeneration time has passed, they get regenerated and can be mined again.

Presets

A "preset" is a section in Blocklist.yml describing how a block should be treated when broken - its drops, what it gets replaced with, what it regenerates into, etc.

It could look something like this:

mine_diamond:
  target-material: DIAMOND_ORE
  replace-block: STONE
  drop-item:
    special_diamond:
      amount: 1-3
      type: DIAMOND

These presets can be later assigned to regeneration regions.

More about presets here.

Regions

A region is an area in which blocks are regenerated according to presets. These regions can be specific selected areas or whole worlds.

More on how to create and configure regions here.

Example configuration

Goal: Configure a region that regenerates diamond ore into gold ore.

First, create a preset configuration in Blocklist.yml.

Blocks:
  diamond:
    target-material: diamond_ore
    regen-delay: 10-20
    regenerate-into: gold_ore
    replace-block: cobblestone
  gold:
    target-material: gold_ore
    regen-delay: 5-10
    regenerate-into: diamond_ore
    replace-block: cobblestone

regenerate diamond ore into gold ore after 10 to 20 seconds, when regeneration takes place, show a cobblestone block
regenerate gold ore into diamond ore after 5 to 10 seconds, when regeneration takes place, show a cobblestone block

Now, create our region - select two points with a wooden axe and run /blockregen region set <name>.
All newly created regions have the all property on. This means all presets are set to regenerate in them. Change this by running /blockregen region all <name>.
Assign your presets with /blockregen region add <region name> gold and /blockregen region add <region name> diamond.

Diamond and gold ores should now regenerate according to the configuration. More about presets and regions.