To create a residence:
Create a residence is easy. All you need to do is equip the selection tool* (wooden pickaxe 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 <amount>
When you’re done modifying your select, type /res create <residence> to confirm your protection.
Tag 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.
<bucket>
Controls use of bucket. True = allows use, false = prevents use.
<build >
Controls building permission (placing and breaking) also prevents crop trampling. True = allows building, false = prevents building.
<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.
<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.
<ignite>
Controls fire ignition. True = allows ignition, false = prevents ignition.
<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.
<move>
Controls whether player/group can move inside the residence. True = normal movement, false = denies entry.
<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.
<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.
<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.
<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.
Superseding flags- These flags are non essential but override parts of the main flags.
Flag
Effect
Overrides
<trample>
Controls whether crops can be trampled. True = Crops can be trampled, False = Crops are protected.
build
<destroy>
Controls ability to break blocks. True = allows block breaking, false = prevents block breaking.
build
<place>
Controls ability to place blocks. True = allows block placing, false = prevents block placing.
build
<waterflow>
Controls whether water can flow. True = water flows normally, false = water does not flow from source block.
flow
<lavaflow>
Controls whether lava can flow. True = lava flows normally, false = lava does not flow from source block.
flow
<cake>
Controls whether cake can be eaten. True = Cake is edible, False = Cake is inedible.
use
<enchant>
Controls whether enchanting tables can be used. True = Can be used, False= Cannot be used.
use
<brew>
Controls whether brewing stands can be used. True = Can be used, False= Cannot be used.
use
<table>
Controls whether workbenches can be used. True = Can be used, False= Cannot be used.
use
<diode>
Controls whether redstone repeaters can be used. True = Can be used, False= Cannot be used.
use
<lever>
Controls whether levers can be used. True = Can be used, False= Cannot be used.
use
<button>
Controls whether buttons can be used. True = Can be used, False= Cannot be used.
use
<door>
Controls whether doors and trapdoors can be used. True = Can be used, False= Cannot be used.
use
<pressure>
Controls whether pressure plates can be used. True = Can be used, False= Cannot be used.
use
<bed>
Controls whether beds can be used. True = Can be used, False= Cannot be used.
use
<note>
Controls whether note blocks can be used. True = Can be used, False= Cannot be used.
use
Macro flags are a new addition to Residence, they allow a res owner to set multiple flags at once. For example, setting <trusted> as true for player Iamnoobz7 would give Iamnoobz7 the build flag, the container flag, the move flag, the use flag, and the tp flag.
Macro Flag
Description
<trusted>
Early "Macro" flag that adds a player with build, container, move, tp, and use.
<redstone>
Macro flag that adds a player with diode, lever, button, and pressure.
<craft>
Macro flag that adds a player with brew, table, and enchant
<fire>
Macro flag that adds to the residence ignite and firespread
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 FlagsTo 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 FlagsIf 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 FlagsThe 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.
Create a residence is easy. All you need to do is equip the selection tool* (wooden pickaxe 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 <amount>
When you’re done modifying your select, type /res create <residence> to confirm your protection.
Tag 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.
<bucket>
Controls use of bucket. True = allows use, false = prevents use.
<build >
Controls building permission (placing and breaking) also prevents crop trampling. True = allows building, false = prevents building.
<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.
<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.
<ignite>
Controls fire ignition. True = allows ignition, false = prevents ignition.
<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.
<move>
Controls whether player/group can move inside the residence. True = normal movement, false = denies entry.
<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.
<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.
<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.
<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.
Superseding flags- These flags are non essential but override parts of the main flags.
Flag
Effect
Overrides
<trample>
Controls whether crops can be trampled. True = Crops can be trampled, False = Crops are protected.
build
<destroy>
Controls ability to break blocks. True = allows block breaking, false = prevents block breaking.
build
<place>
Controls ability to place blocks. True = allows block placing, false = prevents block placing.
build
<waterflow>
Controls whether water can flow. True = water flows normally, false = water does not flow from source block.
flow
<lavaflow>
Controls whether lava can flow. True = lava flows normally, false = lava does not flow from source block.
flow
<cake>
Controls whether cake can be eaten. True = Cake is edible, False = Cake is inedible.
use
<enchant>
Controls whether enchanting tables can be used. True = Can be used, False= Cannot be used.
use
<brew>
Controls whether brewing stands can be used. True = Can be used, False= Cannot be used.
use
<table>
Controls whether workbenches can be used. True = Can be used, False= Cannot be used.
use
<diode>
Controls whether redstone repeaters can be used. True = Can be used, False= Cannot be used.
use
<lever>
Controls whether levers can be used. True = Can be used, False= Cannot be used.
use
<button>
Controls whether buttons can be used. True = Can be used, False= Cannot be used.
use
<door>
Controls whether doors and trapdoors can be used. True = Can be used, False= Cannot be used.
use
<pressure>
Controls whether pressure plates can be used. True = Can be used, False= Cannot be used.
use
<bed>
Controls whether beds can be used. True = Can be used, False= Cannot be used.
use
<note>
Controls whether note blocks can be used. True = Can be used, False= Cannot be used.
use
Macro flags are a new addition to Residence, they allow a res owner to set multiple flags at once. For example, setting <trusted> as true for player Iamnoobz7 would give Iamnoobz7 the build flag, the container flag, the move flag, the use flag, and the tp flag.
Macro Flag
Description
<trusted>
Early "Macro" flag that adds a player with build, container, move, tp, and use.
<redstone>
Macro flag that adds a player with diode, lever, button, and pressure.
<craft>
Macro flag that adds a player with brew, table, and enchant
<fire>
Macro flag that adds to the residence ignite and firespread
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 FlagsTo 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 FlagsIf 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 FlagsThe 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.