Residence

Residence is the self-serve area protection system. If you're used to older versions, ours has simplified things somewhat, especially with commands and the flag GUI, but it is still a massive and somewhat complicated plugin so we'll do our best to walk you through it.

For the purposes of this tutorial, "<" and ">" denote variables contained within and <a|b> indicates that you must use either a or b. With the exception of the slash "/" do not include any special characters in the commands unless explicitly indicated.

Residence Creation

First of all, to access the plugin help menu at any time you can use "/res ?".

Now before we get into how to create a residence, you might also want to know the cost and what your limits are. To view this type "/res limits". Due to the easy availability of our in-game currency the price is currently set at $0.02 per block, with refunds set at $0.01 per block. This sets the minimum residence creation of a 5x5x1 (x z y) area at a total of 50 cents. For a member to purchase a 50x50x20 plot it would cost $1,000. To go bedrock to sky on a 50x50 residence it will cost about $12,750.

Players must be active on the server for Residence protections to persist. If you are inactive more than 60 days the plugin will automatically reclaim the area for the server -- your builds will not be deleted, but protections will. You can bypass this auto-cleanup by supporting the server.

To create a residence, you'll first need to select the area you want to protect. There are two methods for residence selection:

Method One: Use a Stick

If you're not familiar with selecting a cuboid area in Minecraft, try this: imagine that in front of you there is a big cube around the area you want to protect. This cube has 8 corners where the imaginary faces meet -- we're going to pay attention to two of these corners, the one on the bottom left on the front side of the cube, which is what we'll call "position one" and the one on the top right on the back side of the cube, which we'll call "position two". Together these two points can determine the outline of the entire area. See the image to the left for an illustration.

Obtain a stick and left-click the block on the lower left corner of the area you want to protect. This sets the first position. From there you'll want to right-click the second position block at the opposite and upper-most corner of the area. You may need to place a block in either of these corners since you can't select air or liquid with this method. If you do this correctly you should see particles outlining your cuboid area from exactly the blocks you clicked. If the area isn't quite right you can adjust the two points by either left-clicking a new first position or right-clicking a new second position until the particles match the area you want.

Method Two: Use Coordinate Radii

Stand where the exact center of the residence will be.
/res select X Y Z

Your feet are the center block, so X, Y or Z = the radius of blocks along the X, Y or Z axis from your feet. e.g: /res select 10 5 10 = a selection size of 21 11 21. 10 blocks east, 10 west, 1 block in the center, 5 blocks above your feet, 5 blocks below your feet and 1 block where your feet are.

Adjust the Selection (for either method)

If you want to expand the selection from sky to bedrock, type /res select vert
You can also expand the selection by looking in the direction you want to expand and typing /res select expand # (where you replace the # with the number of blocks you want to expand in that direction).
- TIP: One method I've used is to first select a 3x3 area in the blocks at my feet using the stick, left-clicking one corner and right-clicking the opposite corner. From there I simply use the expand commands until the area matches what I'm trying to protect. The particle effects make this particularly easy.
If you selected more than you intended you can also use /res select contract # to contract the residence by # of blocks from the direction you're looking. For example, if your selection is too tall and you want to make it one block shorter you will look up and type /res select contract 1.

Once you're happy with the selection, you can type /res select cost to see the size and price of the selection, or just type /res create <resname> to confirm, where <resname> is a unique name of your choice, such as /res create mercsawesomebuild (no spaces or special characters).

Create Subzones

Subzones are areas within your residence that can have their own flags and their own teleport location. You can use these if you want to set up apartments to rent out to other players, if you want to give someone access to a certain part of your home but not all of it, you have a mob farm in part of your house that you want to allow mobs to spawn in, or if you just want to have a couple different places within your build that you can teleport to because you're too lazy to WASD your way over there. These are free to set up!

Use the same selection methods described above to select an area within your residence. Once selected, type /res subzone <subzonename> to create. And you're good to go!

Set Your Teleport

Every residence has a teleport point, by default usually the center block but can be anywhere the plugin feels like at the time. You can customize your teleport location by standing at the desired location within the residence and typing "/res tpset". Note that half-slabs can make this a little buggy, so try to keep these to full block levels. To use this teleport you can then type "/res tp <resname>". Anyone that you add to your residence will also be able to use this teleport, or you can make it public by typing "/res set tp true". Anyone can then teleport to that location by using the same "/res tp <resname>" command. Subzones can be accessed with "/res tp <resname.subzonename>".