ChocoRent

A lightweight Minecraft Paper plugin for creating rentable WorldGuard regions and letting players lease them with Vault-compatible economies.

Short description

Create protected zones and charge players on a recurring schedule. Supports persistence across restarts, offline charging via Vault, and owner-manageable WorldGuard flags from an interactive GUI.

Features

• Create ProtectedCuboidRegion rent zones using WorldEdit selections
• Persistent rent zones and leases stored in plugin config
• Recurring charge ticker that charges players even when offline (via Vault)
• Lease ownership transfers WorldGuard region ownership to lessee
• Lease owner GUI to toggle common flags (BUILD, PVP, ENTRY)
• Admin commands to manage zones and flags

Requirements

• Paper 1.21.x (or compatible PaperMC)
• WorldGuard 7.x
• WorldEdit 7.x
• Vault API
• An economy plugin compatible with Vault (e.g., EssentialsX (economy), iConomy, etc.)

Installation

1. Build the plugin (recommended: normal jar):
   • gradle build -> jar in build/libs/
2. Drop the produced JAR into your server's plugins/ folder.
3. Install and configure WorldEdit, WorldGuard, Vault, and an economy plugin.
4. Start the server so the default config.yml is generated.

Commands

• /rent help

  • Shows help and usage for all rent commands.

• /rent create <period> <price>

  • Create a new rent zone from your WorldEdit selection.
  • Example: /rent create week 30
  • Permission: chocorent.create (admins bypass)

• /rent delete <regionName>

  • Deletes a rent zone and its WorldGuard region.
  • Permission: chocorent.delete (admins bypass)

• /rent list

  • Lists configured rent zones.
  • Permission: chocorent.list (admins bypass)

• /rent info <regionName>

  • Shows data for a rent zone: period, price, last paid.
  • Permission: chocorent.info (admins bypass)

• /rent visualize

  • Visualize the nearest rent region (particle effect).
  • Permission: chocorent.visualize (admins bypass)

• /rent lease <regionName>

  • Lease a rent zone (withdraws initial payment and registers lease).
  • Permission: chocorent.lease (admins bypass)

• /rent manage

  • Show leases you can manage.

• /rent manage <regionId>

  • Opens an interactive GUI (owners or admins) for toggling common flags.

• /rent manage setflag <regionId> <flag> <allow|deny>

  • Admins can set any WorldGuard StateFlag. Lease owners can toggle BUILD/PVP/ENTRY.

Permissions

• chocorent.admin — full access (default: op)
• chocorent.create — create rent zones (default: op)
• chocorent.delete — delete rent zones (default: op)
• chocorent.list — list zones (default: op)
• chocorent.info — view info (default: op)
• chocorent.visualize — visualize (default: op)
• chocorent.lease — lease a zone (default: true)
• chocorent.manage — manage leases (default: false)

Adjust defaults in your server's permission plugin as required.

config.yml

• rent-zones: stored rent zone definitions (period, price, lastPaid)
• leases: active leases persisted across restarts (regionId, playerUuid, price, periodSeconds, lastPaid)

Example: when a lease is active the plugin will automatically attempt to withdraw the configured price every period and remove the lease if the player cannot pay.