Jump to content

Residence: Difference between revisions

From BadWolfMC Wiki
← Older edit
Merc (talk | contribs)
Bureaucrats, Interface administrators, Administrators, widgeteditor
2,870 edits
VisualWikitext
No edit summary
mNo edit summary
 
(36 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{#evt:
<center><youtube width="720" height="405">Qx37Jkj0-50</youtube></center>
service=youtube
|id=https://www.youtube.com/watch?v=Qx37Jkj0-50
|alignment=center
}}


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.
'''Residence''' is a protection system that players can use to protect their areas. The plugin is complex but allows incredible flexibility and fine-tuning depending on your needs. This tutorial will guide you on how to use 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 Info ==
You can access the plugin's help menu at any time by using '''<code>/res ?</code>'''. To know the cost and limits of your residence, use '''<code>/res limits</code>'''. The price is set at $0.02 per block, and refunds are set at $0.01 per block. This brings the minimum residence creation of a 5x5x1 (x z y) area to a total of 50 cents.


== Residence Creation ==
Protections only persist as long as players are active on the server. 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 [https://www.badwolfmc.com/shop supporting the server].
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.
For the purposes of this tutorial (and our wiki in general), square brackets "<code>[</code>" and "<code>]</code>" indicate a required argument, parentheses "<code>(</code>" and "<code>)</code>" indicate an optional argument, while a pipe "<code>|</code>" between options "<code>[a|b]</code>" 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.


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 [https://www.badwolfmc.com/donate supporting the server].
== Residence Creation ==
 
To create a residence, you need to first select the area you want to protect. You can do this using two methods, using a stick or using coordinate radii. Once you have your selection, you can adjust it using the expand or contract commands until the area matches what you want to protect. To confirm the creation of your residence, type '''<code>/res create [resname]</code>''', where [resname] is a globally unique name without spaces or special characters, e.g. <code>/res create cesarsawesomebuild</code>.
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 ===
=== 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.
[[File:Cuboid selection.png|200px|thumb|right|Visual representation of a cuboid selection, with the red wool as "position one" and the blue wool as "position two".]]
To select a cuboid area in Minecraft, imagine a cube around the desired area with 8 corners. Identify two corners: "position one" on the bottom left of the front side, and "position two" on the top right of the back side. Using a '''stick'''. '''left-click the block at position one''' and '''right-click the block at position two'''. Since you cannot select air or liquid, place blocks in these corners if needed. Adjust your selection as necessary by left-clicking a new position one or right-clicking a new position two. Together these two points can determine the outline of the entire area. See the image to the right 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.
{{Ambox
| type  = notice
| issue = Keep in mind that the y-level is not automatically included in residence creation. Your selection must include ''height''.  
}}


=== Method Two: Use Coordinate Radii ===
=== Method Two: Use Coordinate Radii ===
# Stand where the exact center of the residence will be.
# Stand where the exact center of the residence will be.
# /res select X Y Z
# <code>/res select X Y Z</code>
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.
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: <code>/res select 10 5 10</code> = 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) ===
=== Adjust the Selection (for either method) ===
* If you want to expand the selection from sky to bedrock, type '''/res select vert'''
*To select 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).
*To expand the selection, look in the desired direction and type '''<code>/res select expand #</code>''' (replace # with the number of blocks).  
** '''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.
*To contract the selection in the direction you're looking, use '''<code>/res select contract #</code>'''.  
* 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).
A helpful tip is to select a 3x3 area at your feet with the stick, then use expand commands until you have the desired area.
 
Once you have the desired area selected you can type '''<code>/res select cost</code>''' to see the size and price or type '''<code>/res create [resname]</code>''' to confirm your selection with a unique name like '''<code>/res create cesarsawesomebuild</code>''' (no spaces or special characters).


=== Create Subzones ===
=== 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!
[[File:Subzones.png|200px|thumb|right|What a subzone might look like within your residence.]]
 
Create subzones within your residence to have areas with their own flags and teleport location. These can be used for different purposes such as renting out apartments, restricting or allowing mob spawning in specific parts of your residence, or having multiple teleport locations within your build. To set up a subzone, use the selection methods described above and type '''<code>/res subzone [subzonename]</code>''' to create. This is a free feature!
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 ===
=== 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>'''".
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 '''<code>/res tpset</code>'''. 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 '''<code>/res tp [resname]</code>'''. Anyone that you add to your residence will also be able to use this teleport, or you can make it public by typing '''<code>/res set tp true</code>'''. Anyone can then teleport to that location by using the same '''<code>/res tp [resname]</code>''' command. Subzones can be accessed with '''<code>/res tp [resname.subzonename]</code>'''.


=== Stuck?! ===
=== Stuck?! ===
Sometimes after teleporting to a residence, you may find yourself stuck in an awkward location like someone's secret diamond vault or dungeon sling. Just use '''/res unstuck''' and don't speak of it. Ever.
Sometimes after teleporting to a residence, you may find yourself stuck in an awkward location like someone's secret diamond vault or dungeon sling. Just use '''<code>/res unstuck</code>''' and don't speak of it. Ever.


=== Get Residence Info ===
=== Get Residence Info ===
'''/res info''' - check permissions/details of the residence you are currently in
'''<code>/res info</code>''' - check permissions/details of the residence you are currently in
'''/res info <resname>''' - check permissions/details of the specified residence
 
'''/res list''' - list the residences you own.
'''<code>/res info [resname]</code>''' - check permissions/details of the specified residence  
'''/res list #''' - list residences by page number (if you have more than one page of listings)
 
'''/res sublist''' - list all subzones in current residence
'''<code>/res list</code>''' - list the residences you own.
 
'''<code>/res list #</code>''' - list residences by page number (if you have more than one page of listings)
 
'''<code>/res sublist</code>''' - list all subzones in current residence


== Residence Modification ==
== Residence Modification ==
=== Modify the Area ===
=== Modify the Area ===
To change the size of your entire residence after it has been created, use the following commands while standing in the residence.
To change the size of your entire residence after it has been created, use the following commands while standing in the residence.  
'''/res expand <#>''' - expands the residence in the direction you are facing by the specified amount. Note that this will immediately commit the expansion and charge your account for the associated cost.
 
'''/res contract <#>''' - contracts the residence from the direction you are facing by the specified amount. Again, this is a one-step modification and the changes will be immediate.  
'''<code>/res expand [#]</code>''' - expands the residence in the direction you are facing by the specified amount. Note that this will immediately commit the expansion and charge your account for the associated cost.  
 
'''<code>/res contract [#]</code>''' - contracts the residence from the direction you are facing by the specified amount. Again, this is a one-step modification and the changes will be immediate.  


If you would like to see how much it would cost to expand your residence '''before''' you commit to the expansions, we'll need to use a different method:
If you would like to see how much it would cost to expand your residence '''before''' you commit to the expansions, we'll need to use a different method:
# First select the physical area of the residence by using '''/res select residence <resname> <areaname>'''. The area here is usually just "main".
# First select the physical area of the residence by using '''<code>/res select residence [resname] [areaname]</code>'''. The area here is usually just "main".
# Next use the expansion command '''/res select expand <#>''' until you've selected the desired area (here you can also use '''/res select vert''' to select everything from bedrock to sky -- but know that this gets expensive fast).
# Next use the expansion command '''<code>/res select expand [#]</code>''' until you've selected the desired area (here you can also use '''<code>/res select vert</code>''' to select everything from bedrock to sky—but this gets expensive fast).
# Now you can use '''/res select cost''' to see what the cost of the entire selection would be. Note that this is indeed the cost of the entire selection -- not the cost of the expansion. If you remember the original cost of your residence you can subtract that from this new amount to get the cost of the expansion. The plugin will not otherwise charge you twice for the area you've already purchased.
# Now you can use '''<code>/res select cost</code>''' to see what the cost of the entire selection would be. Note that this is the cost of the entire selection—not the cost of the expansion. If you remember the original cost of your residence you can subtract that from this new amount to get the cost of the expansion. The plugin will not otherwise charge you twice for the area you've already purchased.
# To commit your changes and purchase the additional blocks use '''/res area replace <resname> <areaname>''' (again, where <areaname> is typically "main").
# To commit your changes and purchase the additional blocks use '''<code>/res area replace [resname] [areaname]</code>''' (again, where [areaname] is typically "main").


=== Modify Your Flags ===
=== Modify Your Flags ===
Every residence has a set of flags that you can customize (and some you can't). Flags allow a player to control what happens within the residence. You can also customize flags in subzones. You can set general flags for the entire residence or specific flags for individual players. These can be modified using the GUI or with commands.  
Residences have customizable flags that allow players to control activities within the residence, including subzones. These flags can be modified using the GUI or commands. Some flags, such as animalkilling, build, container, firespread, and creeper, usually default to "false". To revert all flags to their defaults, use '''<code>/res reset [resname]</code>'''.


It is important to note that some of these flags are nested within others (listed in each flag below, but these are usually self-explanatory) to allow fine-tuning of permissions. For example, the "button" flag is nested under "redstone" which is itself nested under "use". The parent flag will usually override the child if the child flag is set to "removed" (some exceptions, noted in the flags), so if you have "use" set to false it will override any of the flags nested within it. So, for example, if you want visitors to be able to push a button but not flip levers you'll need to set "use" to true, "button" to true, and "lever" to false.
Note that some flags are nested within others to allow for fine-tuning of permissions. For example, the "button" flag is nested under "redstone" which is itself nested under "use". The parent flag usually overrides the child if the child flag is set to "removed" (with some exceptions noted in the flags). To allow visitors to push a button but not flip levers, set "use" to true, "button" to true, and "lever" to false.


The commands are divided in two sets:
The commands are divided into two sets:


* '''To set flags for the entire residence and everyone inside it:'''
* '''To set flags for the entire residence and everyone inside it:'''
** Type '''/res set <resname>''' to access the GUI
** Type '''<code>/res set (resname)</code>''' to access the GUI
** Or use '''/res set <resname> <flagname> <true|false>''' to use the commands.
** Or use '''<code>/res set (resname) [flagname] [true|false|removed]</code>''' to use the commands.
** You are able to do both of these commands without including <resname> if you are inside the residence.
** Including the (resname) is optional if you are inside the residence. However, attempting to run the command while standing outside of the residence without including the (resname) will result in an "Invalid Residence" error.
* '''To set flags for specific players:'''
* To set flags for specific subzones (if not standing inside them) you'll want to use '''<code>/res subzone (resname.subzonename) [flagname] [true|false|removed]</code>'''.
** Type '''/res pset <resname> <playername>''' to access the GUI
** Or use '''/res pset <resname> <playername> <flagname> <true|false>''' to use the commands.
** Again, you are able to do these commands without including <resname> if you are inside the residence, but you'll still need to include the <playername>.
** This is where you can set the "trusted" flags for your friends  by using "'''/res pset CesarMC13 trusted true'''".
* If you are setting these flags for specific subzones you'll want to use '''/res subzone <resname.subzonename> <flagname> <true|false>'''.


A list of many of the available flags and explanations is below. Some of these, like animalkilling, build, container, and creeper (should) automatically default to "false". At any time you can revert all of your flags to their defaults by using "'''/res reset <resname>'''".
=== Add Your Friends ===
You can also set specific flags for individual players, also with the GUI or with commands.
*'''To set flags for specific players:'''
** Type '''<code>/res pset (resname) [username]</code>''' to access the GUI.
** Or use '''<code>/res pset (resname) [username] [flagname] [true|false|removed]</code>''' to use the commands.
** Again, you are able to do these commands without including (resname) if you are inside the residence, but you'll still need to include the [username].
** This is where you can set the "trusted" flags for your friends  by using '''<code>/res pset CesarMC13 trusted true</code>'''.
** A similar command exists to add trusted players through <code>/res padd (resname) [username]</code>, but this grants an unusually high level of access so only use it when you explicitly trust someone with full control over the things in your area. Rather, we recommend using the trusted flag described above in conjunction with additional fine-tuning through the pset command whenever necessary.
 
To quickly edit ''existing'' flags for a player in your residence, use the '''<code>/res info</code>''' command and click on their username to bring up the pset GUI for that player. If there are more than 5 players added to a residence and the names are not included in the info list, you can use the -players flag on the command, i.e. '''<code>/res info (resname) -players</code>''' to bring up the full list, then click the desired username from there.
 
=== Remove Your Friends ===
To quickly remove players from your residence use '''<code>/res pdel (resname) [username]</code>'''. This command will only remove any explicitly set permissions for the user, and their permissions will otherwise revert to your current global residence settings applied to all users (set with /res set). To instead deny a specific user access to certain flags beyond your normal residence settings you would need to use the pset command described above.


<div class="toccolours mw-collapsible mw-collapsed">
<div class="toccolours mw-collapsible mw-collapsed">
'''List of flags:'''
===List of Flags===
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
* '''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.
* '''admin''' - Gives a player permission to change flags on a residence
* '''animalkilling''' - Allows or denys animal killing.
* '''anchor''' - Allows or denies respawn anchor usage
* '''brew''' - Allows or denys players to use brewing stands.
* '''animalfeeding''' - Allows or denies animal feeding
* '''bed''' - Allows or denys players to use beds.
* '''animalkilling''' - Allows or denies animal killing
* '''button''' - Allows or denys players to use buttons.
* '''animals''' - Allows or denies animal spawns
* '''burn''' - Allows or denys Mob combustion in residences.
* '''anvil''' - Allows or denies interaction with anvil
* '''build''' - Controls building permission (placing and breaking) also prevents crop trampling. True = allows building, false = prevents building.
* '''beacon''' - Allows or denies interaction with beacon
* '''cake''' - Allows or denys players to eat cake.
* '''bed''' - Allows or denies players to use beds
* '''craft''' - Gives table, enchant, brew flags.
* '''boarding''' - Allows or denies animal boarding in residences
* '''container''' - Controls ability to access anything with an inventory: chests, dispensers, furnaces, also jukeboxes. True = allows access, false = prevents access.
* '''brew''' - Allows or denies players to use brewing stands
* '''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.
* '''brush''' - Allows or denies block brushing
* '''destroy''' - Allows or denys only destruction of blocks, overrides the build flag.
* '''bucket''' - Allows or denies bucket use
* '''diode''' - Allows or denys players to use redstone repeaters.
* '''bucketempty''' - Allows or denies playes to empty buckets in residences
* '''door''' - Allows or denys players to use doors and trapdoors.
* '''bucketfill''' - Allows or denies playes to fill buckets in residences
* '''enchant''' - Allows or denys players to use enchanting tables.
* '''build''' - Allows or denies building
* '''firespread''' - Controls fire spread. True = allows firespread, false = prevents firespread.
* '''burn''' - Allows or denies Mob combustion in residences
* '''flow''' - Controls whether or not liquid flows are allowed. True = allows, false = disallows.
* '''button''' - Allows or denies players to use buttons
* '''healing''' - Controls if the zone heals people. True = heals at half a heart per second, false = normal server rules.
* '''cake''' - Allows or denies players to eat cake
* '''ignite''' - Controls fire ignition. True = allows ignition, false = prevents ignition. Note that this flag does affect Nether Portal creation.
* '''canimals''' - Allows or denies custom animal spawns
* '''itemdrop''' - allows guests to drop items out of their inventory within your residence.
* '''chorustp''' - Allow or disallow teleporting to the residence with chorus fruit
* '''itempickup''' - allows guests to pickup items from the ground within your residence.
* '''container''' - Allows or denies use of furnaces, chests, dispensers, etc...
* '''lavaflow''' - Allows or denys lava flow, overrides flow.
* '''copper''' - Allows to modify copper blocks
* '''leash''' - Allows or denys aninal leash.
* '''coraldryup''' - Allow or deny all corals from drying up
* '''lever''' - Allows or denys players to use levers.
* '''craft''' - Gives table, enchant, brew flags
* '''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.
* '''creeper''' - Allow or deny creeper explosions
* '''mobkilling''' - Allows or denys mob killing.
* '''damage''' - Allows or denies all entity damage within the residence
* '''move''' - Controls whether player/group can move inside the residence. True = normal movement, false = denies entry.
* '''decay''' - Allows or denies leave decay in the residence
* '''nmonsters''' - controls natural monster spawns
* '''destroy''' - Allows or denies only destruction of blocks, overrides the build flag
* '''note''' - Allows or denys players to use note blocks.
* '''diode''' - Allows or denies players to use redstone repeaters
* '''place''' - Allows or denys only placement of blocks, overrides the build flag.
* '''door''' - Allows or denies players to use doors and trapdoors
* '''piston''' - Controls use of pistons. True = pistons operate normally, false = pistons do not change state. Does not control placing or breaking pistons.
* '''dryup''' - Prevents land from drying up
* '''pvp''' - Controls PVP. True = designates PVP arena, false = players cannot attack other players or tamed wolves in the residence.
* '''dye''' - Allows or denies sheep dyeing
* '''pressure''' - Allows or denys players to use pressure plates.
* '''egg''' - Allows or denies interaction with dragon egg
* '''redstone''' - Gives lever, diode, button, pressure, note flags.
* '''enchant''' - Allows or denies players to use enchanting tables
* '''shear''' - Allows or denys sheep shear.
* '''enderpearl''' - Allow or disallow teleporting to the residence with enderpearl
* '''smonsters''' - controls monsters spawned from a spawner or eggs
* '''explode''' - Allows or denies explosions in residences
* '''table''' - Allows or denys players to use workbenches.
* '''fallinprotection''' - Protects from blocks falling into 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.
* '''fireball''' - Allows or denies fire balls in residences
* '''trusted''' - Adds player as friend to residence and adds flags: use, tp, build, container, bucket, move, leash, animalkilling, mobkilling, shear.
* '''firespread''' - Allows or denies fire spread
* '''tp''' - Controls teleportation in the residence. True = allows teleports, false = prevents teleports.
* '''flow''' - Allows or denies liquid flow
* '''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.
* '''flowerpot''' - Allows or denies interaction with flower pot
* '''vehicledestroy''' - Allows or denys vehicle destroy.
* '''flowinprotection''' - Allows or denies liquid flow into residence
* '''waterflow''' - allows or denys water flow, overrides flow.</div>
* '''goathorn''' - Allows or denies goat horn usage
* '''golemopenchest''' - Allow or deny golem open chest
* '''grow''' - Allows or denies plant growing
* '''harvest''' - Allows harvesting
* '''honey''' - Allows or denies players to get honey
* '''honeycomb''' - Allows or denies players to get honeycomb
* '''hook''' - Allows or denies fishing rod hooking entities
* '''hotfloor''' - Prevent damage from magma blocks
* '''iceform''' - Prevents from ice forming
* '''icemelt''' - Prevents ice from melting
* '''ignite''' - Allows or denies fire ignition
* '''itemdrop''' - Allows or denies item drop
* '''itempickup''' - Allows or denies item pickup
* '''lavaflow''' - Allows or denies lava flow, overrides flow
* '''leash''' - Allows or denies aninal leash
* '''lever''' - Allows or denies players to use levers
* '''monsters''' - Allows or denies monster spawns
* '''nametag''' - Allows or denies name tag usage
* '''nanimals''' - Allows or denies natural animal spawns
* '''nmonsters''' - Allows or denies natural monster spawns
* '''note''' - Allows or denies players to use note blocks
* '''phantomspawn''' - Allows or denies phantom spawning
* '''piston''' - Allow or deny pistons from pushing or pulling blocks in the residence
* '''pistonprotection''' - Enables or disabled piston block move in or out of residence
* '''place''' - Allows or denies only placement of blocks, overrides the build flag
* '''pressure''' - Allows or denies players to use pressure plates
* '''pvp''' - Allow or deny pvp in the residence
* '''redstone''' - Nested flag which includes the following subflags: note, pressure, lever, button, and diode
* '''respawn''' - Automaticaly respawns player
* '''riding''' - Prevent riding a horse
* '''sanimals''' - Allows or denies spawner or spawn egg animal spawns
* '''shear''' - Allows or denies sheep shear
* '''shoot''' - Allows or denies shooting projectile in area
* '''shop''' - Adds residence to special residence shop list
* '''skulk''' - Prevents skulk catalyst spreading
* '''smonsters''' - Allows or denies spawner or spawn egg monster spawns
* '''snowball''' - Prevents snowball knockback
* '''snowtrail''' - Prevents snowman snow trails
* '''spread''' - Prevents block spreading
* '''subzone''' - Allow a player to make subzones in the residence
* '''table''' - Allows or denies players to use workbenches
* '''title''' - Shows or hides enter/leave message in residence
* '''tnt''' - Allow or deny tnt explosions
* '''tp''' - Allow or disallow teleporting to the residence
* '''trade''' - Allows or denies villager trading in residence
* '''trample''' - Allows or denies crop trampling in residence
* '''trusted''' - Nested flag which includes the following subflags: use, tp, build, place, door, destroy, container, bucket, move, leash, animalkilling, mobkilling, shear, beacon, itemdrop, itempickup, redstone, and craft.
* '''use''' - Allows or denies use of doors, lever, buttons, etc...
* '''vehicledestroy''' - Allows or denies vehicle destroy
* '''vehicleplacing''' - Allows or denies vehicle placing
* '''visualizer''' - Shows or hides particle visualizer when entering residence
* '''waterflow''' - Allows or denies water flow, overrides flow
* '''witherdestruction''' - Allows or denies wither block damage
* '''witherspawn''' - Allows or denies wither spawning
</div>
</div>
</div>


=== Copying Flags ===
=== Copying Flags ===
A very easy way to set the same flags across your residences is to just use '''/res mirror <sourceresname> <targetresname>'''. You must be owner of both residences to do this.
A very easy way to set the same flags across your residences is to just use '''<code>/res mirror [sourceresname] [targetresname]</code>'''. You must be owner of both residences to do this.


=== Additional Modification Commands ===
=== Additional Modification Commands ===
* '''/res message <resname> <enter|leave> <message>''' - sets a greeting or farewell message for the area. Per usual, no need to include <resname> if you're targeting the one you're currently in. Use <resname.subzonename> to target subzones.
* '''<code>/res message (resname) [enter|leave] [message]</code>''' - sets a greeting or farewell message for the area. Per usual, no need to include (resname) if you're targeting the one you're currently in. Use (resname.subzonename) to target subzones.
* '''/res message <resname> remove <enter|leave>''' - removes your greeting or farewell message.
* '''<code>/res message (resname) remove [enter|leave]</code>''' - removes your greeting or farewell message.
* '''/res rename <OldName> <NewName>''' - renames a residence. For subzones, OldName must be the full name <resname.subzonename>, while NewName is only the new subzone name.
* '''<code>/res rename [OldName] [NewName]</code>''' - renames a residence. For subzones, OldName must be the full name [resname.subzonename], while NewName is only the new subzone name.
* '''/res remove <resname>''' - deletes a residence -- you do receive a 50% refund when you delete your residences.
* '''<code>/res remove [resname]</code>''' - deletes a residence -- you do receive a 50% refund when you delete your residences.
* '''/res removeall''' - deletes all of your residences T_T
* '''<code>/res removeall</code>''' - deletes all of your residences T_T
* '''/res give <resname> <playername>''' - Gives your residence to another player. Player must be online and you must own the residence.
* '''<code>/res give [resname] [playername]</code>''' - Gives your residence to another player. Player must be online and you must own the residence.


== Marketplace Commands ==
== Marketplace Commands ==
* '''/res market''' - displays the plugin help info for this command
[[File:Mall rental.png|200px|thumb|right]]
* '''/res market list''' - view the list of residences for sale.
* '''<code>/res market</code>''' - displays the plugin help info for this command
* '''/res market info <resname>''' - view info on a residence for sale.
* '''<code>/res market list</code>''' - view the list of residences for sale.
* '''/res lease <renew|cost> <resname>''' - renew / show the cost of renewing a residence.  
* '''<code>/res market info [resname]</code>''' - view info on a residence for sale.
* '''/res market sell <resname> <price>''' - put a residence up for sale.
* '''<code>/res lease [renew|cost] [resname]</code>''' - renew / show the cost of renewing a residence.  
* '''/res market unsell <resname>''' - stop selling a residence (only if unsold).
* '''<code>/res market sell [resname] [price]</code>''' - put a residence up for sale.
* '''/res market buy <resname>''' - buy a residence.
* '''<code>/res market unsell [resname]</code>''' - stop selling a residence (only if unsold).
* '''/res market rentable <resname> <price> <days> repeat:<t/f>''' - make a residence rentable for <days> number of days at a time, at <price> for that time period. If repeat:t, the residence will be rentable again automatically at the expiration of the current rental period.
* '''<code>/res market buy [resname]</code>''' - buy a residence.
* '''/res market sign <resname>''' - use this while targeting a blank sign to automatically create the market sign!
* '''<code>/res market rentable [resname] [price] [days] [true|false]</code>''' - make a residence rentable for [days] number of days at a time, at [price] for that time period. If true is used, the residence will be rentable again automatically at the expiration of the current rental period; with false the rental time will expire each period unless manually renewed.
* '''/res market rent <resname> repeat:<t|f>''' - rent a residence, if repeat is true the residence will be re-rented upon expire automatically as long as the owner has repeat:t for the rentable.
* '''<code>/res market sign [resname]</code>''' - use this while targeting a blank sign to automatically create the market sign!
* '''/res market release <resname>''' - remove a residence from rent or rentable status.
* '''<code>/res market rent [resname] [true|false]</code>''' - rent a residence, if repeat is true the residence will be re-rented upon expire automatically as long as the owner has repeat:t for the rentable.
* '''<code>/res market release [resname]</code>''' - remove a residence from rent or rentable status.


Once your res is on the market you can create a sign by simply typing "'''[market]'''" (with the brackets but not the quotes) on the first line of the sign and click "done". The sign should auto-populate with all the necessary information!
Once your res is on the market you can create a sign by simply typing "'''[market]'''" (with the brackets but not the quotes) on the first line of the sign and click "done". The sign should auto-populate with all the necessary information!
Line 162: Line 229:
To use one of these marketplace signs just '''right-click''' to purchase or rent, and if already renting you can '''shift-click to unrent'''.
To use one of these marketplace signs just '''right-click''' to purchase or rent, and if already renting you can '''shift-click to unrent'''.


NOTE: If you are renting a shop from the mall or from someone else, sometimes the proper perms do not immediately attach and you might not be able to place or break items. If this happens do '''/res pset <your-username>''' while standing in the shop to access the flags for yourself. Here you can change place or break to true as needed.
NOTE: If you are renting a shop from the mall or from someone else, sometimes the proper perms do not immediately attach and you might not be able to place or break items. If this happens do '''<code>/res pset [your-username]</code>''' while standing in the shop to access the flags for yourself. Here you can change place or break to true as needed.
 
== Residence FAQ ==
=== Why do I keep getting "invalid residence" errors? ===
This could be a couple things. First, be sure you're executing the commands correctly and fully. If '''<code>/res set</code>''' when used by itself is still giving the error then we recommend checking the boundaries of your residence with '''<code>/svis res</code>''' while standing inside the residence or '''<code>/res show [resname]</code>'''. The vertical axis is not automatically included in residence creation and forgetting it is a common error, frequently resulting in the residence being created only in the floor, for example. The selection must include ''height''. To correct this, be sure that at least your feet are inside the residence, look up, and use the '''<code>/res expand [#]</code>''' commands.
 
=== What flags do I need for villager zombification and healing? ===
The zombification process requires '''animalkilling''', '''monsters''', and '''nmonsters''' to all be '''true'''. The healing process requires '''animals''' and '''nanimals''' to be '''true'''. We recommend creating a subzone in the area you're working in to prevent monsters from spawning in the rest of your residence, then don't forget to turn monsters and nmonsters off once you've finished to prevent further monster spawns.


[[Category:Tutorials]]
[[Category:Tutorials]]

Latest revision as of 06:53, 6 February 2026

Residence is a protection system that players can use to protect their areas. The plugin is complex but allows incredible flexibility and fine-tuning depending on your needs. This tutorial will guide you on how to use it.

Residence Info

You can access the plugin's help menu at any time by using /res ?. To know the cost and limits of your residence, use /res limits. The price is set at $0.02 per block, and refunds are set at $0.01 per block. This brings the minimum residence creation of a 5x5x1 (x z y) area to a total of 50 cents.

Protections only persist as long as players are active on the server. 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.

For the purposes of this tutorial (and our wiki in general), square brackets "[" and "]" indicate a required argument, parentheses "(" and ")" indicate an optional argument, while a pipe "|" between options "[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

To create a residence, you need to first select the area you want to protect. You can do this using two methods, using a stick or using coordinate radii. Once you have your selection, you can adjust it using the expand or contract commands until the area matches what you want to protect. To confirm the creation of your residence, type /res create [resname], where [resname] is a globally unique name without spaces or special characters, e.g. /res create cesarsawesomebuild.

Method One: Use a Stick

Visual representation of a cuboid selection, with the red wool as "position one" and the blue wool as "position two".

To select a cuboid area in Minecraft, imagine a cube around the desired area with 8 corners. Identify two corners: "position one" on the bottom left of the front side, and "position two" on the top right of the back side. Using a stick. left-click the block at position one and right-click the block at position two. Since you cannot select air or liquid, place blocks in these corners if needed. Adjust your selection as necessary by left-clicking a new position one or right-clicking a new position two. Together these two points can determine the outline of the entire area. See the image to the right for an illustration.

Method Two: Use Coordinate Radii

  1. Stand where the exact center of the residence will be.
  2. /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)

  • To select from sky to bedrock, type /res select vert.
  • To expand the selection, look in the desired direction and type /res select expand # (replace # with the number of blocks).
  • To contract the selection in the direction you're looking, use /res select contract #.

A helpful tip is to select a 3x3 area at your feet with the stick, then use expand commands until you have the desired area.

Once you have the desired area selected you can type /res select cost to see the size and price or type /res create [resname] to confirm your selection with a unique name like /res create cesarsawesomebuild (no spaces or special characters).

Create Subzones

What a subzone might look like within your residence.

Create subzones within your residence to have areas with their own flags and teleport location. These can be used for different purposes such as renting out apartments, restricting or allowing mob spawning in specific parts of your residence, or having multiple teleport locations within your build. To set up a subzone, use the selection methods described above and type /res subzone [subzonename] to create. This is a free feature!

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].

Stuck?!

Sometimes after teleporting to a residence, you may find yourself stuck in an awkward location like someone's secret diamond vault or dungeon sling. Just use /res unstuck and don't speak of it. Ever.

Get Residence Info

/res info - check permissions/details of the residence you are currently in

/res info [resname] - check permissions/details of the specified residence

/res list - list the residences you own.

/res list # - list residences by page number (if you have more than one page of listings)

/res sublist - list all subzones in current residence

Residence Modification

Modify the Area

To change the size of your entire residence after it has been created, use the following commands while standing in the residence.

/res expand [#] - expands the residence in the direction you are facing by the specified amount. Note that this will immediately commit the expansion and charge your account for the associated cost.

/res contract [#] - contracts the residence from the direction you are facing by the specified amount. Again, this is a one-step modification and the changes will be immediate.

If you would like to see how much it would cost to expand your residence before you commit to the expansions, we'll need to use a different method:

  1. First select the physical area of the residence by using /res select residence [resname] [areaname]. The area here is usually just "main".
  2. Next use the expansion command /res select expand [#] until you've selected the desired area (here you can also use /res select vert to select everything from bedrock to sky—but this gets expensive fast).
  3. Now you can use /res select cost to see what the cost of the entire selection would be. Note that this is the cost of the entire selection—not the cost of the expansion. If you remember the original cost of your residence you can subtract that from this new amount to get the cost of the expansion. The plugin will not otherwise charge you twice for the area you've already purchased.
  4. To commit your changes and purchase the additional blocks use /res area replace [resname] [areaname] (again, where [areaname] is typically "main").

Modify Your Flags

Residences have customizable flags that allow players to control activities within the residence, including subzones. These flags can be modified using the GUI or commands. Some flags, such as animalkilling, build, container, firespread, and creeper, usually default to "false". To revert all flags to their defaults, use /res reset [resname].

Note that some flags are nested within others to allow for fine-tuning of permissions. For example, the "button" flag is nested under "redstone" which is itself nested under "use". The parent flag usually overrides the child if the child flag is set to "removed" (with some exceptions noted in the flags). To allow visitors to push a button but not flip levers, set "use" to true, "button" to true, and "lever" to false.

The commands are divided into two sets:

  • To set flags for the entire residence and everyone inside it:
    • Type /res set (resname) to access the GUI
    • Or use /res set (resname) [flagname] [true|false|removed] to use the commands.
    • Including the (resname) is optional if you are inside the residence. However, attempting to run the command while standing outside of the residence without including the (resname) will result in an "Invalid Residence" error.
  • To set flags for specific subzones (if not standing inside them) you'll want to use /res subzone (resname.subzonename) [flagname] [true|false|removed].

Add Your Friends

You can also set specific flags for individual players, also with the GUI or with commands.

  • To set flags for specific players:
    • Type /res pset (resname) [username] to access the GUI.
    • Or use /res pset (resname) [username] [flagname] [true|false|removed] to use the commands.
    • Again, you are able to do these commands without including (resname) if you are inside the residence, but you'll still need to include the [username].
    • This is where you can set the "trusted" flags for your friends by using /res pset CesarMC13 trusted true.
    • A similar command exists to add trusted players through /res padd (resname) [username], but this grants an unusually high level of access so only use it when you explicitly trust someone with full control over the things in your area. Rather, we recommend using the trusted flag described above in conjunction with additional fine-tuning through the pset command whenever necessary.

To quickly edit existing flags for a player in your residence, use the /res info command and click on their username to bring up the pset GUI for that player. If there are more than 5 players added to a residence and the names are not included in the info list, you can use the -players flag on the command, i.e. /res info (resname) -players to bring up the full list, then click the desired username from there.

Remove Your Friends

To quickly remove players from your residence use /res pdel (resname) [username]. This command will only remove any explicitly set permissions for the user, and their permissions will otherwise revert to your current global residence settings applied to all users (set with /res set). To instead deny a specific user access to certain flags beyond your normal residence settings you would need to use the pset command described above.

List of Flags

  • admin - Gives a player permission to change flags on a residence
  • anchor - Allows or denies respawn anchor usage
  • animalfeeding - Allows or denies animal feeding
  • animalkilling - Allows or denies animal killing
  • animals - Allows or denies animal spawns
  • anvil - Allows or denies interaction with anvil
  • beacon - Allows or denies interaction with beacon
  • bed - Allows or denies players to use beds
  • boarding - Allows or denies animal boarding in residences
  • brew - Allows or denies players to use brewing stands
  • brush - Allows or denies block brushing
  • bucket - Allows or denies bucket use
  • bucketempty - Allows or denies playes to empty buckets in residences
  • bucketfill - Allows or denies playes to fill buckets in residences
  • build - Allows or denies building
  • burn - Allows or denies Mob combustion in residences
  • button - Allows or denies players to use buttons
  • cake - Allows or denies players to eat cake
  • canimals - Allows or denies custom animal spawns
  • chorustp - Allow or disallow teleporting to the residence with chorus fruit
  • container - Allows or denies use of furnaces, chests, dispensers, etc...
  • copper - Allows to modify copper blocks
  • coraldryup - Allow or deny all corals from drying up
  • craft - Gives table, enchant, brew flags
  • creeper - Allow or deny creeper explosions
  • damage - Allows or denies all entity damage within the residence
  • decay - Allows or denies leave decay in the residence
  • destroy - Allows or denies only destruction of blocks, overrides the build flag
  • diode - Allows or denies players to use redstone repeaters
  • door - Allows or denies players to use doors and trapdoors
  • dryup - Prevents land from drying up
  • dye - Allows or denies sheep dyeing
  • egg - Allows or denies interaction with dragon egg
  • enchant - Allows or denies players to use enchanting tables
  • enderpearl - Allow or disallow teleporting to the residence with enderpearl
  • explode - Allows or denies explosions in residences
  • fallinprotection - Protects from blocks falling into residence
  • fireball - Allows or denies fire balls in residences
  • firespread - Allows or denies fire spread
  • flow - Allows or denies liquid flow
  • flowerpot - Allows or denies interaction with flower pot
  • flowinprotection - Allows or denies liquid flow into residence
  • goathorn - Allows or denies goat horn usage
  • golemopenchest - Allow or deny golem open chest
  • grow - Allows or denies plant growing
  • harvest - Allows harvesting
  • honey - Allows or denies players to get honey
  • honeycomb - Allows or denies players to get honeycomb
  • hook - Allows or denies fishing rod hooking entities
  • hotfloor - Prevent damage from magma blocks
  • iceform - Prevents from ice forming
  • icemelt - Prevents ice from melting
  • ignite - Allows or denies fire ignition
  • itemdrop - Allows or denies item drop
  • itempickup - Allows or denies item pickup
  • lavaflow - Allows or denies lava flow, overrides flow
  • leash - Allows or denies aninal leash
  • lever - Allows or denies players to use levers
  • monsters - Allows or denies monster spawns
  • nametag - Allows or denies name tag usage
  • nanimals - Allows or denies natural animal spawns
  • nmonsters - Allows or denies natural monster spawns
  • note - Allows or denies players to use note blocks
  • phantomspawn - Allows or denies phantom spawning
  • piston - Allow or deny pistons from pushing or pulling blocks in the residence
  • pistonprotection - Enables or disabled piston block move in or out of residence
  • place - Allows or denies only placement of blocks, overrides the build flag
  • pressure - Allows or denies players to use pressure plates
  • pvp - Allow or deny pvp in the residence
  • redstone - Nested flag which includes the following subflags: note, pressure, lever, button, and diode
  • respawn - Automaticaly respawns player
  • riding - Prevent riding a horse
  • sanimals - Allows or denies spawner or spawn egg animal spawns
  • shear - Allows or denies sheep shear
  • shoot - Allows or denies shooting projectile in area
  • shop - Adds residence to special residence shop list
  • skulk - Prevents skulk catalyst spreading
  • smonsters - Allows or denies spawner or spawn egg monster spawns
  • snowball - Prevents snowball knockback
  • snowtrail - Prevents snowman snow trails
  • spread - Prevents block spreading
  • subzone - Allow a player to make subzones in the residence
  • table - Allows or denies players to use workbenches
  • title - Shows or hides enter/leave message in residence
  • tnt - Allow or deny tnt explosions
  • tp - Allow or disallow teleporting to the residence
  • trade - Allows or denies villager trading in residence
  • trample - Allows or denies crop trampling in residence
  • trusted - Nested flag which includes the following subflags: use, tp, build, place, door, destroy, container, bucket, move, leash, animalkilling, mobkilling, shear, beacon, itemdrop, itempickup, redstone, and craft.
  • use - Allows or denies use of doors, lever, buttons, etc...
  • vehicledestroy - Allows or denies vehicle destroy
  • vehicleplacing - Allows or denies vehicle placing
  • visualizer - Shows or hides particle visualizer when entering residence
  • waterflow - Allows or denies water flow, overrides flow
  • witherdestruction - Allows or denies wither block damage
  • witherspawn - Allows or denies wither spawning

Copying Flags

A very easy way to set the same flags across your residences is to just use /res mirror [sourceresname] [targetresname]. You must be owner of both residences to do this.

Additional Modification Commands

  • /res message (resname) [enter|leave] [message] - sets a greeting or farewell message for the area. Per usual, no need to include (resname) if you're targeting the one you're currently in. Use (resname.subzonename) to target subzones.
  • /res message (resname) remove [enter|leave] - removes your greeting or farewell message.
  • /res rename [OldName] [NewName] - renames a residence. For subzones, OldName must be the full name [resname.subzonename], while NewName is only the new subzone name.
  • /res remove [resname] - deletes a residence -- you do receive a 50% refund when you delete your residences.
  • /res removeall - deletes all of your residences T_T
  • /res give [resname] [playername] - Gives your residence to another player. Player must be online and you must own the residence.

Marketplace Commands

  • /res market - displays the plugin help info for this command
  • /res market list - view the list of residences for sale.
  • /res market info [resname] - view info on a residence for sale.
  • /res lease [renew|cost] [resname] - renew / show the cost of renewing a residence.
  • /res market sell [resname] [price] - put a residence up for sale.
  • /res market unsell [resname] - stop selling a residence (only if unsold).
  • /res market buy [resname] - buy a residence.
  • /res market rentable [resname] [price] [days] [true|false] - make a residence rentable for [days] number of days at a time, at [price] for that time period. If true is used, the residence will be rentable again automatically at the expiration of the current rental period; with false the rental time will expire each period unless manually renewed.
  • /res market sign [resname] - use this while targeting a blank sign to automatically create the market sign!
  • /res market rent [resname] [true|false] - rent a residence, if repeat is true the residence will be re-rented upon expire automatically as long as the owner has repeat:t for the rentable.
  • /res market release [resname] - remove a residence from rent or rentable status.

Once your res is on the market you can create a sign by simply typing "[market]" (with the brackets but not the quotes) on the first line of the sign and click "done". The sign should auto-populate with all the necessary information!

To use one of these marketplace signs just right-click to purchase or rent, and if already renting you can shift-click to unrent.

NOTE: If you are renting a shop from the mall or from someone else, sometimes the proper perms do not immediately attach and you might not be able to place or break items. If this happens do /res pset [your-username] while standing in the shop to access the flags for yourself. Here you can change place or break to true as needed.

Residence FAQ

Why do I keep getting "invalid residence" errors?

This could be a couple things. First, be sure you're executing the commands correctly and fully. If /res set when used by itself is still giving the error then we recommend checking the boundaries of your residence with /svis res while standing inside the residence or /res show [resname]. The vertical axis is not automatically included in residence creation and forgetting it is a common error, frequently resulting in the residence being created only in the floor, for example. The selection must include height. To correct this, be sure that at least your feet are inside the residence, look up, and use the /res expand [#] commands.

What flags do I need for villager zombification and healing?

The zombification process requires animalkilling, monsters, and nmonsters to all be true. The healing process requires animals and nanimals to be true. We recommend creating a subzone in the area you're working in to prevent monsters from spawning in the rest of your residence, then don't forget to turn monsters and nmonsters off once you've finished to prevent further monster spawns.

Retrieved from "https://wiki.badwolfmc.com/w/index.php?title=Residence&oldid=6618"