GPExpansion

<p align="center"> <img alt="GPExpansion" width=100% height=auto src="https://repository-images.githubusercontent.com/1126629614/19884d9d-e1cc-40ce-88e5-774ba811e5d7"> </p>

<p align="center">Extend GriefPrevention with rental signs, mailboxes, and more</p>

<p align="center"> <a href="https://discord.com/invite/pCKdCX6nYr"><img alt="Discord" src="https://img.shields.io/badge/Discord-Community-5865F2?style=for-the-badge&logo=discord&logoColor=white"></a> <a href="https://github.com/castledking/GriefPrevention3D"><img src="https://img.shields.io/badge/GitHub-Repository-181717?style=for-the-badge&logo=github" alt="GitHub Repository"></a> <a href="https://github.com/castledking/GriefPrevention3D/issues"><img src="https://img.shields.io/badge/GitHub-Issues-181717?style=for-the-badge&logo=github" alt="GitHub Issues"></a> <a href="https://github.com/castledking/GriefPrevention3D/wiki"><img src="https://img.shields.io/badge/GitHub-Wiki-181717?style=for-the-badge&logo=github" alt="GitHub Wiki"></a> </p>

GPExpansion adds powerful features to sign protection including sign protection, sign protection, sign protection, sign protection, sign protection, sign protection, and more — all while maintaining the self-service philosophy.

Haven't heard of GriefPrevention 3D Subdivisions? Get it here to enable mailbox support. This is a fork that replaces the GriefPrevention jar.

---

Supported Platforms

Spigot, Paper, Purpur, and Folia

Requires GriefPrevention and optionally Vault for economy features.

Optionally, replace GriefPrevention with GriefPrevention3D for seamless mailboxes (1x1x1 subdivisions and public container trust). Mailboxes will work with regular GP and there is a config setting called `mailbox-protocol: virtual` that helps if you want to be able to stack mailboxes on top of each other.

---

Features

🏠 Rental Signs

Allow claim owners to rent out their claims to other players using signs. - Set rental prices and durations - Automatic trust/untrust on rental start/expiry - Supports Vault economy, experience, claim blocks, and item-based payments - Interactive setup wizard with `/rentclaim` command - Rental Snapshots – Save and restore claim state between renters

🏷️ Sell Signs

Allow claim owners to sell their claims to other players using signs. - Set claim prices - Automatic transfer of ownership of claim - Supports Vault economy, experience, claim blocks, and item-based payments - Interactive setup wizard with `/sellclaim` command

📬 Claim Mailboxes

Give each claim a mailbox where other players can deposit items. - Owners have full access to retrieve items - Non-owners see a virtual inventory (snapshot at open time) - Changes save only when the menu closes - Can take back items before closing (reversible deposits) - Items returned if mailbox fills up while viewing - Chest opening sound/animation on sign click - Storage warnings when mailbox is nearly full - Purchasable via signs with configurable prices - Interactive setup wizard with `/mailbox` command

Virtual protocol - Owners and renters can place `[Mailbox]` wall signs directly on containers in claims they own or rent - Virtual protocol (config `mailbox-protocol: real`): creates a 1x1x1 subdivision (GP3D) or 1x1 2D subdivision (regular GP) and grants public container trust so non-owners see the real chest with live updates - Virtual protocol (config `mailbox-protocol: virtual`): no subdivision; non-owners get a virtual snapshot, no live updates. Allows for stackable mailboxes on regular GP. - Configurable limit via `defaults.max-self-mailboxes-per-claim`

🌍 Global Claims

Allow claims to be listed in a global claim list, viewable to all. - Set global settings like icon, description, name, spawn point, and more - Allows users to teleport to global claims via GUI by default - Allows `[global]` claim signs to instantly set spawn and list as global - Simple `/claim global <true|false>` command to manage global listing status

🔒 Sign Protection

Protect your rental and mailbox signs from unauthorized modification. - Admin-only sign breaking for active rentals - Automatic cleanup on sign removal

📸 Rental Restoration Snapshots

Admins with `griefprevention.restoresnapshot` can save and restore claim block state for rentals. When a rental or eviction ends, the claim can be restored to a saved snapshot so the next renter sees the original build.

- Restore – Save the current claim blocks as a snapshot (e.g., before listing for rent) - Restore – View snapshots for a claim or for all claims - Restore – On eviction or rental end, the latest snapshot is applied automatically

Commands: - `/claim snapshot create [claimId]` – Create a snapshot - `/claim snapshot list [claimId|all]` – List snapshots - `/claim snapshot remove <snapshotId>` – Delete a snapshot

📋 Claim Management & GUIs

Interactive claim management with fully configurable GUIs: - `/claim name <name>` - Set claim name (supports color codes with permissions) - `/claim desc <description>` - Set claim description (uses same color permissions as name) - `/claim icon <material>` - Set claim icon for GUI display - `/claim spawn` - Set the teleport spawn point for your claim - `/claim tp [claimId]` - Teleport to a claim's spawn point - `/claim flags [claimId]` - Open the claim flags GUI (GPFlags) - `/claim options [claimId]` - Open the claim options GUI - `/claim ban <player>` - Ban players from your claims - `/claim unban <player>` - Unban players from your claims - `/claim info [claimId]` - View detailed claim information - `/mailbox` - Manage your mailboxes - `/gpx reload` - Reload configuration and language files - `/gpx max` - Manage player sign creation limits

Claim GUI Features: - Visual claim map editor – Resize, subdivide, and manage claims via interactive GUI - Customizable layouts, icons, and permissions - Teleport to claims, view claim info, and manage settings from one interface - Integration with GPFlags for claim flag management

💰 Configurable Tax System

Optional tax system for claim maintenance: - Configurable tax rates per claim block - Multiple payment methods (money, claim blocks, experience) - Grace periods before claim deletion - Tax exemptions via permissions

---

Documentation

Sign formats, configuration, permissions, and detailed guides Sign formats, configuration, permissions, and detailed guides

---

Support

- Issue Tracker - Report bugs or problems - Discussions - Feature requests and questions - Wiki - Detailed documentation and guides - Discord - Join our community

---

Building from Source

```bash git clone https://github.com/castledking/GPExpansion.git cd GPExpansion mvn clean install ```

The compiled jar will be in `target/`.

---

<p align="center"> <i>Built to extend GriefPrevention with love ❤️</i> </p>