#

Extend GriefPrevention with rental signs, mailboxes, and more

GPExpansion adds powerful features to [GriefPrevention](https://github.com/GriefPrevention/GriefPrevention) including **rental signs**, **claim mailboxes**, **global claims**, **rental snapshots**, **claim GUIs**, **sign protection**, and more — all while maintaining the self-service philosophy. Haven't heard of GriefPrevention 3D Subdivisions? Get it [here](https://github.com/castledking/GriefPrevention3D) to enable mailbox support. This is a fork that replaces the GriefPrevention jar. ### Supported Platforms **Spigot, Paper, Purpur, and Folia** Requires [GriefPrevention](https://github.com/GriefPrevention/GriefPrevention) and optionally [Vault](https://github.com/MilkBowl/Vault) for economy features. Optionally, replace GriefPrevention with [GriefPrevention3D](https://github.com/castledking/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

Setting up a rental sign manually

### 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

Setting up a sell sign manually

### 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

Creating a self mailbox

Selling a mailbox to other players

Sharing a mailbox with other players

### Self Mailboxes (Instant Creation) - Owners and renters can place `[Mailbox]` wall signs directly on containers in claims they own or rent - Configurable limit via `defaults.max-self-mailboxes-per-claim` | Protocol Type | Subdivision Created | Non-Owner View | Live Updates | Stackable | | --- | --- | --- | --- | --- | | Real Protocol | 1x1x1 (GP3D) or 1x1 2D (regular GP) | Real chest with public container trust | Yes | No | | Virtual Protocol | None | Virtual snapshot inventory | No (snapshot at open time) | Yes | ### 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 ` 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. - **Create** – Save the current claim blocks as a snapshot (e.g., before listing for rent) - **List** – 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 ` – Delete a snapshot ### Claim Management & GUIs Interactive claim management with fully configurable GUIs: - `/claim name ` - Set claim name (supports color codes with permissions) - `/claim desc ` - Set claim description (uses same color permissions as name) - `/claim icon ` - 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 ` - Ban players from your claims - `/claim unban ` - 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 ### CrowBar Locator Bar Integration When [CrowBar](https://github.com/castledking/CrowBar), a Fabric client mod, is installed alongside GPExpansion, claim waypoints display the **claim name** and a **bowtie marker** on the locator bar to the claim owner and trusted players. CrowBar reads the same locator data GPExpansion sends and renders readable name tags above each waypoint. ![GPX-CrowBar](https://castled.codes/assets/gpx-crowbar.png) - Works automatically when both GPExpansion and CrowBar are installed — no extra configuration needed. - Claim names appear above the bowtie waypoint marker on the locator bar. - Compatible with Minecraft 1.21.6–1.21.11, 26.1.x, and 26.2.

### Documentation **Sign formats, configuration, permissions, and detailed guides** [All here](https://github.com/castledking/GPExpansion/blob/main/README.md) ### Support - [Issue Tracker](https://github.com/castledking/GPExpansion/issues) - Report bugs or problems - [Discussions](https://github.com/castledking/GPExpansion/discussions) - Feature requests and questions - [Wiki](https://github.com/castledking/GPExpansion/wiki) - Detailed documentation and guides - [Discord](https://discord.gg/pCKdCX6nYr) - Join our community ### Building from Source ``` git clone https://github.com/castledking/GPExpansion.git cd GPExpansion mvn clean install ``` The compiled jar will be in `target/`.

Built to extend GriefPrevention with love ❤️