ZoneRental

ZoneRental - Complete WorldGuard Region Rental System

A comprehensive Minecraft plugin for managing rental regions with clickable signs, multi-world support, and complete lifecycle automation.

What is ZoneRental?

ZoneRental is a feature-rich rental management plugin that allows players to rent WorldGuard regions through clickable signs. The plugin handles the complete rental lifecycle including automatic expiration, block restoration, item storage, and economy integration.

Perfect for servers with player shops, market stalls, or any rentable spaces where you need automatic management and restoration.

Why Download This?

- EzChestShop Integration - Everything is automated from rental to expiration - EzChestShop Integration - Regions automatically restore to original state - EzChestShop Integration - All items from containers are saved and retrievable - EzChestShop Integration - Works across overworld, nether, end, and custom worlds - EzChestShop Integration - Per-region pricing, durations, and settings - EzChestShop Integration - Full Vault support with any economy plugin - EzChestShop Integration - Allow friends to access your rented regions - EzChestShop Integration - Players can extend rentals with configurable limits - EzChestShop Integration - Full transaction history for all refunds - EzChestShop Integration - Automatic shop removal on expiration

Essential Information Before Downloading

Requirements

Required Dependencies: - Vault (economy API) - WorldGuard 7.0.14+ (region management) - WorldEdit 7.3.16+ (block restoration) - Any economy plugin (EssentialsX, CMI, etc.)

Optional Dependencies: - LuckPerms (advanced permissions) - EzChestShop (automatic shop removal)

Compatibility

- Java Version: Paper, Spigot, or any Paper-based fork - Java Version: 1.21+ - Java Version: Java 21 required (OpenJDK recommended)

Installation Steps

1. Install required dependencies (Vault, WorldGuard, WorldEdit, Economy plugin) 2. Download ZoneRental JAR file 3. Place in `plugins/` folder 4. Restart server (configuration files will be auto-generated) 5. Configure `config.yml` to your preferences 6. Create WorldGuard regions: `/rg define <region>` 7. Place signs and create rental signs: `/zrcreatesign <region>`

Core Features

Rental Management

- Teleportation - Right-click to rent, shift-click to extend - Teleportation - Same region names work independently across worlds - Teleportation - Regions automatically expire and restore - Teleportation - Players can extend rentals up to configured limits - Teleportation - Add/remove members to share rented regions - Teleportation - Players can teleport to their rented regions

Economy & Pricing

- Extension Refunds - Works with any economy plugin - Extension Refunds - Set custom prices for specific regions - Extension Refunds - Configurable extension costs - Extension Refunds - VIP pricing through permissions - Extension Refunds - Admin resets provide 100% refunds - Extension Refunds - Optional refunds when duration is reset

Block Restoration

- World-Aware - Captures and restores block states - World-Aware - Optionally restore entities (mobs, armor stands) - World-Aware - Optionally restore biome data - World-Aware - Configurable automatic schematic deletion - World-Aware - Restoration happens in the correct world

Item Storage

- Auto-Cleanup - Automatically saves items from all containers - Auto-Cleanup - `/zrretrieve` command to get stored items - Auto-Cleanup - Players notified when items are stored - Auto-Cleanup - Items removed after retrieval

Admin Tools

- Sign Protection - All per-region settings via `/zroverride` commands - Sign Protection - Group regions for mass configuration changes - Sign Protection - Add, remove, set, or reset rental time - Sign Protection - Startup verification of region configurations - Sign Protection - Complete transaction tracking per rental - Sign Protection - Signs and support blocks are protected from breaking

Integration Features

- Notification System - Automatic chest shop removal on expiration - Notification System - Automatic member management - Notification System - Full permission system integration - Notification System - Configurable expiration warnings

User Commands

- `/zr help` - Show help menu - `/zrinfo <region>` - View rental information - `/zrlist [player]` - List active rentals - `/zrextend <region>` - Extend a rental - `/zrretrieve` - Get stored items from expired rentals - `/zrmember add/remove <region> <player>` - Manage members - `/zrmembers <region>` - List members of rented region - `/zrtp <region>` - Teleport to rented region

Admin Commands

- `/zrcreatesign <region>` - Create rental sign - `/zrreload` - Reload configuration - `/zrreset <region>` - Reset rental with full refund - `/zrduration <add|remove|set|reset> <region> [time]` - Modify duration - `/zroverride <subcommand> <target> <value>` - Per-region settings - `/zrgroup <subcommand>` - Manage region groups - `/zrremove <region>` - Remove rental setup completely - `/zrrefundhistory <region>` - View refund transaction history - `/zrverify` - Verify region configurations

Permissions

User Permissions (default: true): - `ZoneRental.rent` - Rent regions - `ZoneRental.extend` - Extend rentals - `ZoneRental.retrieve` - Retrieve stored items - `ZoneRental.info` - View rental info - `ZoneRental.list` - List your rentals - `ZoneRental.member` - Manage members - `ZoneRental.members` - View members - `ZoneRental.tp` - Teleport to rentals

Admin Permissions (default: op): - `ZoneRental.admin.*` - All admin permissions - `ZoneRental.admin.reload` - Reload plugin - `ZoneRental.admin.createsign` - Create rental signs - `ZoneRental.admin.reset` - Reset rentals - `ZoneRental.admin.duration` - Modify durations - `ZoneRental.admin.override` - Per-region settings - `ZoneRental.admin.remove` - Remove rental setup - `ZoneRental.admin.refundhistory` - View refund history - `ZoneRental.admin.verify` - Verify configurations - `ZoneRental.admin.bypass` - Bypass restrictions - `ZoneRental.admin.breaksign` - Break rental signs - `ZoneRental.admin.list.others` - List others' rentals - `ZoneRental.admin.group` - Manage region groups

Configuration Files

The plugin creates six configuration files:

1. rentals.yml - Main configuration (economy, durations, messages) 2. rentals.yml - Per-region overrides (managed via commands) 3. rentals.yml - Region group definitions 4. rentals.yml - Sign locations and support blocks 5. rentals.yml - Item storage from expired rentals 6. rentals.yml - Active rental data (runtime)

Plus a `schematics/` folder for WorldEdit region snapshots.

Quick Start Guide

1. Done! (Vault, WorldGuard, WorldEdit, Economy plugin) 2. Done! to generate configs 3. Done! in `config.yml` 4. Done! `/rg define shop1` 5. Done! where you want players to interact 6. Done! `/zrcreatesign shop1` 7. Done! `/zroverride price shop1 500.0` 8. Done! Players can now right-click the sign to rent

Support & Documentation

- Version History: See repository README.md - Version History: See BUILDING.md - Version History: See CHANGELOG.md

Source Code & License

- License: https://github.com/Warstorm548/ZoneRental - License: AGPL-3.0 (open source)

Development Note

- this plugin was Developed utilizing claude code, ai-assisted Development - The plugin is tested manually in a test server environment to ensure minimal bugs and reduce issues that may be persent in the code.