Minecraft Forums

• Allows players to define protected areas for themselves.
• Allows players to rent their own land to other people for amount of money for defined time period.
• Allows players to sell their land to other players
• Land "leasing" system which requires users to renew the lease on their protection every X number of days or loose the protection. (off by default, see config file)
• Option to kick players from your residence
• Integrated residence sign system to have easy way for selling/renting
• Integrated residence chat system
• Easy to use area selection tool with unique selection visualizer in game.
• Shows bounds of residence with particle effects if you can't enter it
• Detailed region information
• Individual permissions for each protected area. Land owner can give / deny permissions globally or to other specific players.
• Integrated GUI for easy flags changes
• Different permissions per land include: move, build, use, pvp, fire, teleport, monsters spawn, damage prevention... in total over 75 different flags to play around
• Automatic residence removal if player is X days offline
• AntiGrief prevention for all possible ways players can think of
• Teleport system to allow users to teleport to residences.
• Collision detection system to prevent residences from overlapping.
• Sub-zoning. Create zones within zones, and then zones within those zones...
• Couple ways to select land including using the select command, using a item to select 2 points or auto selection on player move.
• Messages when you enter / leave a residence. (customizable)
• In-game help / commands descriptions

The first thing you should know about Residences is their structure. Residences exist of areas, where each area is a cuboid. Using the selection tool (wooden hoe) you left-click one corner and right-click the opposite corner. The entire area in-between, up to and including the corners, is then your selection.

There is a handful of "/res select …" commands that aid in the Selection process. The first is "/res select size". This will tell you the X, Y and Z dimensions of your selection, as well as the total size. While claiming is simply a matter of selecting two opposite corners, sometimes this isn’t viable. For this you can use the expand commands. To use the expand option, simply look in a direction (up/down/north/south/east/west) and use "/res select expand [amount]". Negative numbers can be used to adjust for an overshoot. So say you want to raise the roof with 5, just look up and type "/res select expand 5". Another useful expansion command is "/res select vert". This turns your selection to one ranging from sky to bedrock.

Selected areas are used for 3 different things: Creating a residence’s initial area, selecting additional areas to add to a residence, and creating subzones inside a residence.

With your brand new central area selected, it’s now time to create a residence. This is done with "/res create [resname]" where resname is whatever you want to call the place. However, a residence doesn’t have to be a single cuboid. Rather than having 1 cuboid as a residence, you can stitch multiple cuboids together in 1 residence. They can overlap or be completely disjunct and even separated. Unfortunately you you still have to pay the full dime for any area, no matter how much of it overlaps with land that’s already yours.

When you want to add an area to a residence, you go through the same selection process. Then, rather than doing the same old "/res create …", you instead use "/res area add [resname] [areaname]". The name of the area isn’t that relevant, especially when it can be renamed.

It should be noted that while residences can clearly not overlap with others, areas within your residence are allowed to overlap with other areas within.

The main part of Residence is that it lets you protect your buildings and possessions. You can disallow griefing, lock your chests and doors, disallow pvp and firespread, block tnt and creeper explosions, cancel monster spawns and a few more. Even better, you can give specific people rights to let friends help you with building your cathedral, while also giving them access to the shared storage the supplies are stored in. There are three kinds of permission flags: general flags, group flags and individual flags. Group flags are the same as individual flags but set for groups instead.The commands are:

• /res set [residence] [flag] [true/false/remove]
• /res gset [residence] [group] [flag] [true/false/remove]
• /res pset [residence] [person] [flag] [true/false/remove]

If you are standing inside the residence, you can leave out the residence name.

Some special notes:

• When a residence is made, a few default values will be set.
• The command "/res tpset" lets one set a teleport point for "/res tp [residence]". If not used, a player will teleport to near the SW corner of the residence. Has to be manually set for each subzone, they do not use the general teleport point.
• Merely allowing spread or spawning does not mean it will happen. The other conditions, such as light, all still apply.
• When +piston is set, a player outside your residence can use pistons to add or extract blocks in your residence. Try avoiding setting this flag on true in main residences, only use it in subzones that aren’t adjacent to the outside of the residence.

General flags

Animals
Allows/disallows the spawning of passive animals. Also applies to Pig Spawners.

Creeper
If false, disallows creeper explosions in/near the residence. A creeper will just sizzle and disappear.

Firespread
Allows/disallows the spreading of fire. If false, blocks won’t burn up but remain on fire.

Flow
Allows/disallows flowing of water and lava. The lavaflow and waterflow flags override this one.

Healing
If on, players heal an additional half heart per second. If off, normal mechanics apply.

Ignite
Allows/disallows the manual starting of fires.

Monsters
Allows/disallows all kinds of monster spawning. Monsters from the outside can still enter even with spawning off.

Piston
Allows/disallows usage of pistons. If false, pistons from inside and outside can’t work if at least 1 block would be part of, or be pushed into, the residence.

PvP
Allows/disallows the attacking of players and tamed wolves.

Spread
Allows/disallows the spread of grass and mycelium.

TNT
If false, TNT disappears without explosion when detonated in/near the residence.

Individual flags

Bucket
Allows/disallows the usage of buckets.

Build
Allows/disallows placement and destruction of blocks.

Container
Allows/disallows access to objects with an inventory: Chests, Furnaces, Dispensers.

Move
Controls whether people can walk around in the residence. If disallowed, the game will stop them when they try.

Subzone
Allows/disallows the creation of subzones by a player or in general.

TP
If residence-teleporting is allowed for a player, this controls whether they can teleport to this specific residence. Is connected to “/res tpset” as described below.

Use
Allows/disallows usage of doors, levers, buttons, trapdoors. Pressureplates are not included and can always be used by anyone.

The flags alone aren’t what makes Residence as strong a protection plugin as it is. Its true strength comes from the ability to create subzones, which are parts of a Residence with their own permission flags. A few uses of this are shared storage, publicly and privately accessible areas, railroad stations and temporary construction zones.

It’s very important to be familiar with the difference between areas and subzones. Areas are the physical portions of claim land that combined make up a residence. Subzones are virtual zones inside a residence that are extensions to the right-system but carry no physical presence. Adding a subzone does not make a house bigger, it simply lets you define specific rooms. Also, subzones can be stretched over multiple physical areas of a residence.

To create a subzone, first select the area with the selection tool as explained before. Then, use the following command:

• /res subzone [resname] [subzonename]

After this, the subzone will be [resname].[subzonename]. For example, in a residence Capetown there is a Mall, which can be accessed with the resname Capetown.Mall. I could use "/res set Capetown.Mall use true" to let people open doors in it, or "/res set Capetown.Mall move false" to temporarily block all access while I reconstruct the place.

As mentioned before, when standing in a residence you can leave out the residence name from the set commands. When leaving out the name, the deepest subzone you are in will be changed. So when inside Capetown, commands will impact Capetown. Inside the general area of the Mall, Capetown.Mall will change. Inside a shop, for example F1_A, Capetown.Mall.F1_A will have its rights changed.

As for the flags of a residence, an inheritage system is used. First, the subzone is checked for a personal flag. If no true/false value is present, the next level is checked, and so on, until the main residence. If no personal value is found, group flags are checked in the same order, after that the general flags. If not a single level has the flag set to true or false, the default value of the server will be used.
Thus, if you do "/res set X.Y use true" and "/res pset X Jerk use false", the player Jerk cannot open doors in X.Y. After all, X.Y has no value set for Jerk, so then X is checked, which says "no way bro". If at any point you use "/res pset X Jerk use remove", no flag will be set for Jerk and the system will use the general flag set in X.Y instead.

With subzones you can give people basic rights, such as build/use/container, to give them a room in your place. However, they are still fully dependant on you for setting additional rights as well as giving others rights. You also have to manually give them the rights. If you want to avoid that hassle, you can sell or rent out the rooms using the Residence Market. While technically this is possible with entire residences, chances are you’ll only use it for subzones. To keep things easy, marketing main residences will not be discussed.

When someone buys or rents a residence, or subzone of one, they receive full control over it. This means they can tear its contents down, build and set flags. The easiest thing you can do is put a subzone up for sale. The commands for that are below, but first the more complex part: Renting. Renting exists of 3 factors: The rent per period, the length of the period, and whether or not it can be rented for multiple periods at length. If someone decides to rent the place and it can be rented for multiple periods, they can decide for themselves whether they are willing to. And if they want to, they can cancel the contract and hand the subzone back over with a single command.

In this commandlist, [residence] is the full name of the residence. For a subzone, be sure to use [residence.subzone]

/res market sell [residence] [amount]
Puts a residence/subzone for sale for [amount].

/res market unsell [residence]
Use this to withdraw a residence/subzone from the market.

/res market buy [residence]
Use this to buy an available residence/subzone.

/res market rentable [residence] [cost] [days]
Makes a residence/subzone rentable for a defined amount of days at a time, with the given cost per period. If repeat is on, it can be automatically rerented by the renter if they so desire.

/res market rent [residence]
Rent a residence/subzone. Set repeat to true if you want to rerent when the rent period ends. Only possible if the landlord has allowed repeated renting.

/res market release [residence]
When a place is still on the market, the owner can use this to take it off the market. When someone is renting the place, they can use this to bail on it and hand it back to the owner.

/res market info [residence]
Provides you with the name and price of a residence/subzone, as well as its rental parameters if it’s a rental.

One can browse the market, either by checking out the info of a specific residence/subzone, or by checking the list of everything for sale or rent. Unfortunately this list currently does not seem fond of whitespace, resulting in a string of symbols and dots without an easy way to see where one name ends and another begins. But there is one remedy: When inside a residence/subzone that’s for sale or rent, using the "/res market info" command without the name will give you the information regardless, including the name. So all that a city owner needs to do is for-sale signs and open doors, then a player can simply enter, check the place out with "/res info", check its price with "/res market info". If they want the place, they can then use the buy or rent command, whichever applies.

There are two important details one must keep in mind when using the market:

• Just because you buy a subzone, doesn’t mean the rights inheritance system no longer applies. Any personal rights in the main residence or higher zones apply, unless you specifically oppose them. That means a city owner has a responsibility not to give others rights in the main residence, they’d have to use temporary construction subzones instead. It also means that if you can’t trust the owner, you shouldn’t get the place, since they can give anyone access to their residence and thus your house.

Chests, doors, furnaces, dispensers are protected on placement by default. But the above is what you would use for a basic private protection. Password protection is the same deal.

Now pay attention to what happens in the chat box once you hit enter:

Hit your chest and you'll have a protection!

As a user or owner of a protection, you can use /cinfo on a protection which will let you view information on a protection. An example of this command is below.

Or a private protection, which you own:

You'll probably notice this has an 'Access Control List' under it.

Private protections can have various 'Access Control Lists', or who exactly can access the protection. The owner is considered just that - the owner - and cannot be removed from the protection, only by using/cremove on it.

You can add (and remove) access from a protection both when creating it and after you create it. If you wanted to add your friends at the same time you used /cprivate you'd use something like:/cprivate player1 player2 .. and then hit your protection. You'll get something like:

Adding access afterwards is done with /cmodify

->

Removing ACLs / players from a protection is as easy as prepending -

->

And finally, entire permission groups (defined with the perms plugin) can be granted to a protection by prepending g:

->

You can grant a player or group "admin" access to the protection. This means that they can use /cmodify (but not /cremove) to edit the protection. They will NOT be able to remove the owner (as the owner is outside the bounds of ACL) and thus can only add or remove other players.

This is done by using @

->

Additionally, admins will show up in /cinfo as an admin.

Finally, they can be removed just like any other group/player by prepending -

->

• Ingame Shop Editor making it super-easy to create/edit a Shop
• Edit shops without breaking signs
• SELL ALL - Player Shops
• Shop Usage statistic as well as an estimated Income/Outgoings Value based on the Usage Statistic
• Schedule (disable the shop at certain times when you don't want anyone to interact with it)
• Admin shops
• Display Item above Shop also showing a Nametag with the Name of the Item
• Unique Marketstands (Rentable Shops)

Place a sign with the following values:

1st Line = [Shop]

2nd Line = Quantity

3rd Line = Price - The recommended price of items can be found using

4th Line = Buy/Sell/Sellall

After adding your sign, you will need to right click it to open up the Shopmenu to edit the shop. The Shop Editor is where you can edit all aspects of your shop. These include the item, the type (buy/sell/sellall), time when the shop is open and not, if the shop is open currently, and a lot more! The item in the top left is the item you are selling/buying. Click it to change it to the item in your hand.

These shops can be rented for a price/day at spawn. This feature keeps things fair, and allows for an atmosphere of competition on the server.

To rent a shop, just right-click on a sign that is open and says [Marketstand]. You will then be allowed to rent for +1, +2, +3 days. To increase the amount of days you rent for, simply right-click the sign and choose amount of days to increase by.