Skip to content
FamousL edited this page Mar 4, 2024 · 9 revisions

Welcome! Here is where I will describe the features of this version of the RealEstate Plugin.

Credit goes to EtienneDx for the original plugin.

Installation

To install this plugin, simply get the latest release for your version from the Releases section, and add it to your plugins folder along with the following dependencies.

This plugin currently depends on Grief Prevention, Vault, and Essentials. There is also a soft dependency (you can choose to use this or not) on WorldEdit.

Once loaded, the plugin will create its own directory with a config.yml file that you can modify to suit your needs.

Usage

Currently there are 3 different usage types: Selling, Renting, and Leasing claims.

Selling

Selling does exactly what you would expect, transfers ownership from one person to another. The seller loses all rights to the claim once sold. By default, selling a subclaim is not possible as you cannot transfer ownership of a subclaim.

To sell a claim, place a sign like the example below: Sale sign If successful, the sign will change to look like this: sale_success

Once the sign reflects a sale, any user can use it to purchase the claim. The claim blocks making up the claim will be transferred, by default.

Renting

Renting a claim or subclaim gives the buyer build access for a given period of time. At the end of the time, the rent is either renewed (extending the time the buyer can use the space), or not, removing them from all access over the claim.

To create a rental space, place a sign as follows: rent sign If successful, the sign will change to look like this:

2024-03-04_07 23 51

The format for duration is simple, first weeks, then days: "1 week 3 days" will result in a total of 10 days "2 weeks" will result in a total of 14 days "3 day" will result in a total of 3 days "12w 4d" will result in a total of 88 days (12*7 + 4) "3d" will result in 3 days and so on...

To preview the offer, sneak right-click, to accept the offer, a player need only right click to accept the conditions. This will cause the sign to drop.

Rental ending:

If the configuration is set to use worldedit, the following things will happen (depending on configuration).

UseWorldEdit

When rental period ends, restore rental space to how it was when the rental sign was placed (User structures will be removed, ores and other blocks will NOT be restored.)

RestoreAdminClaimsOnly

This will only restore admin claims by default, user claims will be left in whatever state they happen to be in when rental ends.

SaveInventory

This will take every inventory holding block, save its contents into an ender-chest like space (not the buyer's enderchest) for later retrieval by the buyer, and destroy the block (placing that into the same inventory as well).

Leasing

Leasing is similar to renting, however at the end of the term, the buyer keeps the claim. The lease is paid as multiple payments split by a certain amount of time between each. If, for any reason, the buyer cannot pay (payments happen automatically), the lease is canceled.

The following example shows a lease created with payments of 10 in-game currency, among 3 payments, with 10 weeks between payments. (An unrealistic scenario, that is possible with this plugin.)

To create a lease claim, place a sign like the following example: lease If successful, the sign will change to look like this: lease_success

To preview the offer, sneak right-click, to accept the offer, a player need only right click to accept the conditions. This will cause the sign to drop.

Configuration options

A full rundown of the configuration is available here.

Clone this wiki locally