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?

• Zero Manual Management - Everything is automated from rental to expiration
• WorldEdit Restoration - Regions automatically restore to original state
• Item Safety - All items from containers are saved and retrievable
• Multi-World Support - Works across overworld, nether, end, and custom worlds
• Flexible Configuration - Per-region pricing, durations, and settings
• Economy Integration - Full Vault support with any economy plugin
• Member System - Allow friends to access your rented regions
• Extension System - Players can extend rentals with configurable limits
• Complete Refund Tracking - 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

• Server Software: Paper, Spigot, or any Paper-based fork
• Minecraft 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

• Clickable Signs - Right-click to rent, shift-click to extend
• Multi-World Support - Same region names work independently across worlds
• Automatic Expiration - Regions automatically expire and restore
• Extension System - Players can extend rentals up to configured limits
• Member Management - Add/remove members to share rented regions
• Teleportation - Players can teleport to their rented regions

Economy & Pricing

• Vault Integration - Works with any economy plugin
• Per-Region Pricing - Set custom prices for specific regions
• Extension Pricing - Configurable extension costs
• Permission-Based Discounts - VIP pricing through permissions
• Full Refund System - Admin resets provide 100% refunds
• Extension Refunds - Optional refunds when duration is reset

Block Restoration

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

Item Storage

• Container Scanning - Automatically saves items from all containers
• Player Retrieval - /zrretrieve command to get stored items
• Notification System - Players notified when items are stored
• Auto-Cleanup - Items removed after retrieval

Admin Tools

• Command-Based Config - All per-region settings via /zroverride commands
• Region Groups - Group regions for mass configuration changes
• Duration Management - Add, remove, set, or reset rental time
• Auto-Verification - Startup verification of region configurations
• Refund History - Complete transaction tracking per rental
• Sign Protection - Signs and support blocks are protected from breaking

Integration Features

• EzChestShop - Automatic chest shop removal on expiration
• WorldGuard - Automatic member management
• LuckPerms - 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. config.yml - Main configuration (economy, durations, messages)
2. regions.yml - Per-region overrides (managed via commands)
3. groups.yml - Region group definitions
4. signs.yml - Sign locations and support blocks
5. storage.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. Install dependencies (Vault, WorldGuard, WorldEdit, Economy plugin)
2. Restart server to generate configs
3. Configure settings in config.yml
4. Create a WorldGuard region: /rg define shop1
5. Place a sign where you want players to interact
6. Create rental sign: /zrcreatesign shop1
7. Optionally customize: /zroverride price shop1 500.0
8. Done! Players can now right-click the sign to rent

Support & Documentation

• Full Documentation: See repository README.md
• Build Instructions: See BUILDING.md
• Version History: See CHANGELOG.md

Source Code & License

• Repository: 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.