Skip to content
EtienneDx edited this page Apr 28, 2019 · 6 revisions

Welcome to the RealEstate wiki!

Here will be listed all features included in the RealEstate plugin!

Installation

To install this plugin, simply get the latest release for your version of minecraft from the releases section, and add it to your plugins folder.

After running the server once, some files will get created in the plugins/RealEstate folder, including the config.yml file, that you can change to fit your needs.

Usage

This plugin currently includes 3 different usage types : Selling, Renting and Leasing claims.

Selling

Selling a claim transfers it to the buyer once bought. The seller loses all his right over the claim once sold. By default, a player cannot sell subclaim, since it's impossible to transfer ownership over a subclaim.

To sell a claim, you simply need to setup a sign as follow : preSell

The sign will then change into a selling sign : postSell

Anyone can then access the sale informations by sneak-right clicking the sign, and buy it by simply right clicking it.

Once bought, the sign is destroyed directly.

Renting

Renting a claim or subclaim gives the buyer build access for a given period of time. At the end of this period of time, the rent is either renewed, which leaves the buyer build access, or not, and the player loses all access over the claim.

To put a claim for rent, you need to write a sign as follow : preRent

The format for the duration is simple, first the weeks, then the days :

  • "1 week 2 days" means a total of 9 days
  • "2 weeks" means a total of 14 days
  • "3 day" means a total of 3 days
  • "12w 5d" means a total of 89 days (12*7 + 5)
  • "3d" means 3 days
  • and so on...

Again, the sign will then turn into a rent sign, that can be used just as the sell sign above.

Once rented, the sign will indicate who is renting the claim, and until when. This could potentially change, depending on feedback and future evolutions already planned.

Automatic payments can be setup using the /re renewrent [enable|disable] command.

Leasing

Leasing is close to renting, the difference being that at the end, the buyer gets to keep the claim. The lease is paid as multiple payments, split by a certain amount of time between each. If at some point, the buyer cannot pay (the payment is automatic), the lease is cancelled.

To create a lease for a claim, you only need to place a sign containing those informations : preLease

This indicates a lease consisting of 3 payments of 10 dollars, each separated by one day.

Again, sneak-right click for informations and right click to accept the lease contract. The sign will get destroyed as soon as someone accepts the contract.

Evolution

Next version

For now, the only way to break a lease contract is to be out of money, and you can't break a rent contract. Soon, a command will be introduced to do such thing.

The renting feature is also going to evolve, to include an optionnal fixed amount of payments, so the contract could be 5x a week, paying for it week after week. This more contractual approach would limit the number of times a player can rent a claim, and introduce a new use for the exit contract command (still to come).

Maybe someday

  • A command to propose to buy/rent/lease a claim to another player
  • A command to list all sales/rents/leases
  • Who knows... :)

Contribute

If you wish to contribute, either for the wiki or the code, please feel free to do so. (Grammar correction is a huge contribution ^^)

Clone this wiki locally