User Documentation

RegenSystem is a powerful and flexible block regeneration plugin designed for:

• PvP Box servers
• Mining worlds
• Survival zones
• Event areas

It allows you to define cuboid zones that automatically regenerate after a configurable delay, with fine-grained control using flags, permissions, and menus.

---

Table of Contents

1. Introduction
2. Installation
3. Supported Platforms & Versions
4. Quick Start (Create Your First Zone)
5. Commands
6. Permissions
7. Zones & Regeneration
8. Flags System
9. Configuration Files
10. Menus & GUI
11. Placeholders (PlaceholderAPI)
12. Performance & Safety
13. FAQ

---

1. Introduction

RegenSystem lets you:

• Define cuboid zones using commands or a selection wand
• Automatically regenerate blocks after a delay
• Enable or disable regeneration globally or per zone
• Control zone behavior using flags (PvP, block break, explosions, etc.)
• Use a modern, platform-safe architecture compatible with Paper, Folia, and Spigot

The plugin automatically adapts to your server platform to ensure maximum stability and performance.

---

2. Installation

Requirements

• Java 17+ (Java 21 recommended)
• Minecraft 1.20.x → 1.21.x
• Paper / Folia / Spigot server

Installation Steps

1. Download RegenSystem-VERSION.jar
2. Drop it into your plugins/ folder
3. (Optional) Install PlaceholderAPI
4. Start or restart your server

On first start, the plugin will generate its configuration files automatically.

---

3. Supported Platforms & Versions

Server Platforms

Platform	Status
Paper	✅ Fully supported (recommended)
Folia	✅ Fully supported (region-safe & async-safe)
Spigot	✅ Supported (automatic fallbacks)

ℹ️ RegenSystem automatically detects your server platform at runtime.

Minecraft Versions

• Supported: 1.20.x → 1.21.x
• Older versions: ❌ Not supported yet

---

4. Quick Start (Create Your First Zone)

Step 1 – Get the selection wand

/regen wand

You receive a diamond axe.

• Left click → pos1
• Right click → pos2

ℹ️ You can also define zones using /regen pos1 and /regen pos2 if you don’t want to use the wand.

Step 2 – Save the zone

/regen save mine 60

• Creates a zone named mine
• Regenerates every 60 seconds

Step 3 – Done

Blocks inside the zone will now regenerate automatically.

---

5. Commands

Command	Description
/regen help [page]	Shows the help menu
/regen wand	Gives the selection axe
/regen pos1	Set first corner
/regen pos2	Set second corner
/regen save [delay]	Save a new zone
/regen delete	Delete a zone
/regen snapshot	Update zone block data
/regen reload [zone]	Reload zones
/regen menu	Open the GUI
/regen lang	Change plugin language

---

6. Permissions

Permission	Description
regensystem.*	Full access
regensystem.command	Base command
regensystem.save	Save zones
regensystem.delete	Delete zones
regensystem.reload	Reload zones
regensystem.menu	Access GUI
regensystem.flag	Manage flags
regensystem.update	Update notifications

All permissions default to OP.

Use a permission plugin (LuckPerms, etc.) to manage access for players.

---

7. Zones & Regeneration

Each zone:

• Is defined by two corners
• Stores a snapshot of original blocks
• Regenerates blocks after a delay (in seconds)
• Can be enabled/disabled independently

Zones are persisted using SQLite (zone.db) for performance and safety.

---

8. Flags System

Flags allow you to control zone behavior.

Example Flags

Flag	Description
BLOCK_BREAK	Allow breaking blocks
BLOCK_PLACE	Allow placing blocks
PVP	Enable PvP
MOB_SPAWN	Allow mob spawning
EXPLOSION	Allow explosions
ITEM_PICKUP	Allow item pickup

Manage flags

/regen flag <zone> <flag> <on|off>

---

9. Configuration Files

plugins/
└── RegenSystem/
    ├── config.yml     # Plugin messages & prefix (do NOT edit version !)
    ├── zone.yml       # Zones definition : positions, delays, enabled flags
    ├── version.cache  # Don't touch this file
    └── zone.db        # 🔥 Block data storage (SQLite, auto-managed)

zone.yml

This file contains the definitions for your zones : their position, delay, and status.

global:
  regen-enabled: true      # Enable or disable regeneration globally

zones:
  mine:                   # Replace with your own zone names
    pos1: world,100,64,100 # First corner of the cuboid (x, y, z)
    pos2: world,110,70,110 # Second corner of the cuboid (x, y, z)
    regenDelay: 60         # Delay in seconds
    enabled: true          # If false, the zone won't regenerate
    flags:                 # Zone-specific flags
      BLOCK_BREAK: true
      ITEM_DROP: true
      MOB_SPAWN: true
      PVP: true
      BLOCK_PLACE: true
      MOB_DAMAGE: true
      EXPLOSION: true
      ITEM_PICKUP: true

config.yml

⚠️ Do not edit the version field – it’s used internally for updates.

version: 3                    # ⚠️ Do not modify!
debug: false                  # For more information in the logs
prefix: "&6[RegenSystem] &r"  # Prefix used in plugin messages
updates:
  check-interval: 12          # In hours
  notify-admins: true         # To notify the admins

---

10. Menus & GUI

The /regen menu command opens an interactive GUI that allows you to:

• Enable or disable zones
• Modify flags
• Manage regeneration settings

No commands required.

---

11. Placeholders (PlaceholderAPI)

If PlaceholderAPI is installed, RegenSystem automatically registers placeholders.

Examples

Placeholder	Description
%regen_zone_count%	Total zones
%regen_timer_<zone>%	Time before regen
%regen_enabled_<zone>%	Zone status

No configuration needed.

---

12. Performance & Safety

• Region-safe on Folia
• Async-safe schedulers
• No unsafe chunk access
• Minimal memory usage
• Cached update checks
• No background spam

RegenSystem is designed to scale safely to large servers.

---

13. FAQ

❓ Can I use this on Spigot?

Yes. The plugin automatically uses legacy fallbacks.

❓ Does it support multiple worlds?

Yes. Zones are world-specific.

❓ Can I disable regen temporarily?

Yes:

/regen disable <zone>

❓ Is the API available?

Yes. See Developer Documentation.