Creating, Protecting and Modifying

Introduction: Creating a residence is easy, and many options can be applied to it to allow further customization and protection. If you still have trouble understand, please check the Residence spigot forum thread.

To create a residence:

• Create a residence is easy. All you need to do is equip the selection tool* (wooden hoe by default) and select the two corners of the area you want to protect.
• You can also do this with /res select [x] [y] [z]
• If you want to expand the selection from sky to bedrock, type /res select vert
• You can expand the selection by looking in the direction you want to expand and typing /res select expand
• When you're done modifying your select, type /res create to confirm your protection.

Explanation: For the purpose of this explanation:

• <residence> - is the name of the residence you want to edit.
• <player> - is the name of the player you want the changes to effect
• <group> - is the name of the group you want the changes to effect
• <flag> - is the flag you want to use.
• <true/false/remove> - is either true or false. This turns a flag on and off. False=off, True=on.
  • True = will be allowed to happen e.g. if fire is true, fire can spread. If build is true, players can build.
  • False = will not be allowed to happen e.g. if pvp is false, players can't hurt each other.
  • Remove = will remove the flag from the residence or player.

Flag Explanation:

• Here are some descriptions of the flags that can be applied to protect a residence.

• The ones in brown are only applicable to a residence, not to a player.

• All flags default to true unless stated otherwise.

• <admin> - Allows or disallows player to set flags on the Residence. True = allowed, false = disallowed. Defaults to false. Can only be given to a player and not set as a residence flag.

• <animals> - Controls animals spawning. True = allows spawning, false = prevents spawning. Includes external commands such as /spawnmob. Animals include: Chicken, Cow, Pig, Sheep, Wolf, rabbit, horse.

• <animalkilling> - Allows or denys animal killing.

• <brew> - Allows or denys players to use brewing stands.

• <bed> - Allows or denys players to use beds.

• <button> - Allows or denys players to use buttons.

• <burn> - Allows or denys Mob combustion in residences.

• <build> - Controls building permission (placing and breaking) also prevents crop trampling. True = allows building, false = prevents building.

• <cake> - Allows or denys players to eat cake.

• <craft> - Gives table, enchant, brew flags.

• <container> - Controls ability to access anything with an inventory: chests, dispensers, furnaces, also jukeboxes. True = allows access, false = prevents access.

• <creeper> - Controls creeper explosions. True = creepers explode and damage as normal, false = creepers do no damage to players or blocks. Does not prevent creepers spawning.

• <damage> - Controls all damage to players in the Residence. True = damage occurs as normal, false = prevents all damage. Does not stop block damage.

• <destroy> - Allows or denys only destruction of blocks, overrides the build flag.

• <diode> - Allows or denys players to use redstone repeaters.

• <door> - Allows or denys players to use doors and trapdoors.

• <enchant> - Allows or denys players to use enchanting tables.

• <firespread> - Controls fire spread. True = allows firespread, false = prevents firespread.

• <flow> - Controls whether or not liquid flows are allowed. True = allows, false = disallows.

• <healing> - Controls if the zone heals people. True = heals at half a heart per second, false = normal server rules.

• <hiden> - Hides residence from list or listall commands.

• <ignite> - Controls fire ignition. True = allows ignition, false = prevents ignition.

• <lavaflow> - Allows or denys lava flow, overrides flow.

• <leash> - Allows or denys aninal leash.

• <lever> - Allows or denys players to use levers.

• <monsters> - Controls monsters spawning. True = allows spawning, false = prevents spawning. Includes external commands such as /spawnmob. Monsters include: Creeper, Giant, Monster (Human mob/Steve), Skeleton, Spider, (Pig)Zombie.

• <mobkilling> - Allows or denys mob killing.

• <move> - Controls whether player/group can move inside the residence. True = normal movement, false = denies entry.

• <note> - Allows or denys players to use note blocks.

• <nofly> - Allows or denys fly in residence. Overrides with residence.fly.override permission node.

• <place> - Allows or denys only placement of blocks, overrides the build flag.

• <piston> - Controls use of pistons. True = pistons operate normally, false = pistons do not change state. Does not control placing or breaking pistons.

• <pvp> - Controls PVP. True = designates PVP arena, false = players cannot attack other players or tamed wolves in the residence.

• <pressure> - Allows or denys players to use pressure plates.

• <redstone> - Gives lever, diode, button, pressure, note flags.

• <subzone> - Controls ability to make subzones. True = allowed, false = disallowed. Defaults to false. If set on a residence, allows or disallows subzones of the residence.

• <shear> - Allows or denys sheep shear.

• <table> - Allows or denys players to use workbenches.

• <tnt> - Controls TNT explosions. True = TNT explodes and damages as normal, false = TNT does no damage to players or blocks. Does not prevent TNT placing or breaking.

• <trusted> - Adds player as friend to residence and adds flags: use, tp, build, container, bucket, move, leash, animalkilling, mobkilling, shear.

• <tp> - Controls teleportation in the residence. True = allows teleports, false = prevents teleports.

• <use> - Controls ability to use/access objects in the residence. True = normal server rules, false = denies usage. This includes doors, chests, furnaces, dispensers, levers etc. Overrides 'container' if applicable.

• <vehicledestroy> - Allows or denys vehicle destroy.

• <waterflow> - allows or denys water flow, overrides flow.

• <command> - allows or denys command use in residence.

• <nomobs> - prevents monsters from entering residence.

Setting up a residence with flags:

• Once you have your residence created, you can apply a number of different flags(see above) to help further protect it.

Residence Flags

To set up flags on your residence, use the following command:

/res set <residence> <flag> <true/false>

Example: /res set area1 build false - this will stop anyone being able to build in the residence 'area1', except the owner. /res set area1 move false - this will stop anyone being able to move in the residence 'area1', except the owner.

Group Flags

If you want to set flags per group, use the following command:

/res gset <residence> <group> <flag> <true/false>

Example:

/res gset area1 ops move true - this will allow all ops to move in the residence 'area1', as well as the owner.

Player Flags

The same works with individual players. You can assign flag permissions to an individual by using the pset command.

/res pset <residence> <player name> <flag> <true/false>

Example:

/res pset area1 danjames build true This would mean that even if Residence permissions are set to BUILD=FALSE, the player danjames will be able to build. Flags have an order that they are checked when a player tries to do something within a residence. First Player Flags are checked, and if not found then Group Flags are checked, and then finally Residence Flags are checked.

If you have permissions set up, and you have the residence.admin permission node, you will bypass any and all flags.