Configuration

AreaRegen Commands

This wiki details the commands for managing areas in the AreaRegen plugin. Areas define regions in the game world that can be regenerated after events like explosions. All commands are prefixed with /arearegen and require specific permissions.

Table of Contents

• Overview
• General Commands
• Area Creation and Selection
• Area Modification
• Block List Management
• Area Regeneration
• Notes

Overview

The AreaRegen plugin allows server administrators to create, modify, and regenerate areas. Key features include:

• Area Creation: Define regions using a selection tool.
• Regeneration: Restore areas after explosions or manually.
• Block Filtering: Use blacklists and whitelists to control which blocks regenerate.
• Configuration: Adjust delays, regeneration times, and save settings.

Commands are restricted to players with appropriate permissions, typically operators or users with arearegen.* permissions.

General Commands

These commands manage the plugin’s configuration and area data.

Command	Description	Permission	Example
/arearegen reload	Reloads the plugin’s configuration from areas.yml.	arearegen.reload	/arearegen reload
/arearegen store-config	Saves the current configuration to areas.yml.	arearegen.storeconfig	/arearegen store-config
/arearegen list-areas	Lists all defined areas with their names and worlds.	arearegen.listareas	/arearegen list-areas
/arearegen load-areas	Loads areas from areas.yml into memory.	arearegen.loadareas	/arearegen load-areas

• Notes:
  • Use reload after editing areas.yml manually.
  • store-config ensures changes persist across server restarts.
  • list-areas helps verify loaded areas (e.g., area1 in world).

Area Creation and Selection

These commands create new areas or set up selections for defining area bounds.

Command	Description	Permission	Example
/arearegen wand	Gives a selection tool (stick) to set two corner points for an area. Left-click for corner 1, right-click for corner 2.	arearegen.wand	/arearegen wand
/arearegen create <areaName>	Creates a new area with the specified name using the current selection.	arearegen.createarea	/arearegen create area1

• Usage:

  1. Run /arearegen wand to get a stick.
  2. Left-click a block to set corner 1 (e.g., -145, 73, -250).
  3. Right-click a block to set corner 2 (e.g., -140, 73, -250).
  4. Run /arearegen create <areaName> to create the area.

• Example Output: Area 'area1' created successfully: Point A: (-145, 73, -250) Point B: (-140, 73, -250)

  Notes:

  • delay and regen-time use ticks (20 ticks = 1 second).

  • Ensure the area exists before modifying (use list-areas).

Area Modification

These commands modify existing areas’ properties or bounds.

Command	Description	Permission	Example
/arearegen edit-selection [areaName]	Updates the bounds of an existing area using the current selection. Requires using the wand first.	arearegen.editarea	/arearegen edit-selection area1
/arearegen delay [areaName] [value]	Sets the delay (in ticks) before regeneration starts for the specified area.	arearegen.setdelay	/arearegen delay area1 20
/arearegen regen-time [areaName] [value]	Sets the regeneration interval (in ticks) between block updates for the specified area.	arearegen.setregentime	/arearegen regen-time area1 10

• Usage for edit-selection:

  1. Use /arearegen wand to select new corners.

  2. Run /arearegen edit-selection [areaName] to update bounds.

• Example Output:

  Bounds of area 'area1' updated successfully: Point A: (-150, 70, -240) Point B: (-145, 75, -235)

• Notes:

  • delay and regen-time use ticks (20 ticks = 1 second).

  • Ensure the area exists before modifying (use list-areas).

Block List Management

These commands manage blacklisted or whitelisted blocks for area regeneration.

Command	Description	Permission	Example
/arearegen blacklist add [areaName] [block1,block2]	Adds blocks to the blacklist, preventing them from regenerating.	arearegen.blacklist	/arearegen blacklist add area1 STONE,DIRT
/arearegen blacklist remove [areaName] [block1,block2]	Removes blocks from the blacklist.	arearegen.blacklist	/arearegen blacklist remove area1 STONE
/arearegen blacklist clear [areaName]	Clears all blacklisted blocks for the area.	arearegen.blacklist	/arearegen blacklist clear area1
/arearegen whitelist add [areaName] [block1,block2]	Adds blocks to the whitelist, allowing only these blocks to regenerate.	arearegen.whitelist	/arearegen whitelist add area1 GRASS_BLOCK,SAND
/arearegen whitelist remove [areaName] [block1,block2]	Removes blocks from the whitelist.	arearegen.whitelist	/arearegen whitelist remove area1 SAND
/arearegen whitelist clear [areaName]	Clears all whitelisted blocks for the area.	arearegen.whitelist	/arearegen whitelist clear area1

• Notes:

  • Block names use Minecraft material names (e.g., STONE, GRASS_BLOCK).

  • Blacklist takes precedence over whitelist.

  • Use commas to separate multiple blocks.

Area Regeneration

These commands trigger area regeneration.

Command	Description	Permission	Example
/arearegen regen [areaName]	Instantly regenerates the specified area to its saved state.	arearegen.regen	/arearegen regen area1

• Notes:

  • Regeneration respects blacklist/whitelist settings.

  • Containers (e.g., chests) are emptied during regeneration (see Notes).

Notes

• Selection Tool:

  • The /arearegen wand command (or /select) provides a stick for selecting area corners.

  • Left-click sets the first corner, right-click sets the second.

  • Confirm selections with /select confirm if using the selection system.

• Permissions:

  • Most commands require operator status or specific permissions.

  • Grant all permissions with arearegen.*.

• Configuration:

  • Areas are stored in plugins/AreaRegen/areas.yml.

  • Save changes with /arearegen store-config after modifying areas.

• Regeneration:

  • Areas regenerate automatically after explosions.

  • Use /arearegen regen for manual regeneration.

• Troubleshooting:

  • If areas don’t regenerate, check blacklist/whitelist settings.