Quarters: Difference between revisions

From EarthMC
Jump to navigation Jump to search
m (Protected "Quarters" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
mNo edit summary
 
Line 1: Line 1:
Quarters allows for much finer control over properties within a Towny town.
Quarters extends the functionality of towns and plots to allow the creation of apartments. Standard plots are restricted to a simple grid-based system that requires allowing and restricting permissions of an entire chunk. Quarters can instead allow for dynamically sized cuboids in which permissions can be edited.
[[File:Quarters Front Image.png|thumb|636x636px|Because residents deserve the bare minimum.]]
Players can use a wand or a series of user-friendly commands to subdivide their town into 3D areas. The advantage this provides over stock Towny is not being limited by the perms applying to an entire town block, you can give players permissions to much more specific areas and stop wasting your land.
 
The wand item is flint by default, this can be used to select two corners that form a rectangular cuboid area that can be turned into a "quarter" (as in "living quarters") by a player using <code>/q create</code>. The flint also makes a handy tool to covertly scratch your tenant's floors to ensure you keep the security deposit.
 
While a player is holding the wand item, both their currently selected area and quarters that currently exist within the town they are standing in will be displayed with an outline of particles.
 
== Creating a quarter ==
== Creating a quarter ==
The most intuitive way to create a quarter is to use the wand item, this is by default flint. If you cannot get access to a wand, the commands <code>/quarters pos1</code> and <code>/quarters pos2</code> will suffice.
To create a quarter you need to be the mayor or councillor, then you can select two positions using flint, this is the "wand" item in Quarters. With two positions selected, an outline of a cuboid will appear showing your selection while you are holding the wand. To proceed type <code>/q selection add</code>, if you would like to add more cuboids to your selection, repeat selecting two positions and adding them with the same command.<syntaxhighlight lang="java">
 
TIP: If you cannot get access to a flint you can use /q pos1 and /q pos2 to select at your feet.
=== Selecting a region ===
</syntaxhighlight>With your cuboids selected run the command <code>/q create</code>, if you have the necessary permissions this will turn all your selected cuboids into a quarter. These cuboids will all share a particle outline and permissions.
Click on the two opposing corners of where you want to create a new quarter, left for pos1, right for pos2. Ensure the positions you select form an area that is entirely within a singular town with no wilderness inside it's bounds. On a server with a default Quarter's config your selection should be highlighted with a series of particles, adjust your selection if it is not correct.
 
Once you have the area you want to turn into a quarter selected, type <code>/quarters selection add</code>, this will add that cuboid to your currently selected cuboids and the particle outline will change to reflect this. If you would like to add more cuboids to your selection to create a custom shape select another area and add it to your selection with that command again. Keep in mind that cuboids within your selection are not allowed to overlap, but they are allowed to be separate from each other.
 
If you have made a mistake with your selection, you can stand within a cuboid you have added already and type <code>/quarters selection remove</code> to remove it from your selection. Additionally, you can send <code>/quarters selection clear</code> to completely remove all cuboids you have currently selected.


Keep in mind that while creating a quarter some servers may impose certain restrictions such as a maximum number of cuboids per quarter, max number of quarters per town, or max block volume per cuboid.
== Quarter prerequisites​ ==
The following requirements must be met in order to create a quarter:


=== Making a quarter from your selection ===
* The quarter is entirely within a single town
With your quarter selected, type <code>/quarters create</code> and if your quarter is still in a valid location it should be created without issue. It will be given a default particle colour that you can change with <code>/quarters colour {r} {g} {b}</code>.
* There is no wilderness within any of the cuboid's bounds
* Your selected cuboids do not overlap with any pre-existing cuboids


== Quarter Types ==
Existing quarters will be deleted if any of the above requirements are no longer true, for example if the underlying town block is unclaimed or the town is deleted.
Quarters comes out of the box with a few different quarter types to choose from. You can change a quarter's type with the command <code>/quarters type {type}</code> or by using the admin command <code>/quartersadmin type {type}</code>


=== Apartment ===
== Permission management​ ==
This is the default quarter type, it can have an owner and the owner can set trusted users. The owner, anyone they have trusted, and anyone with perms in the underlying Towny plot have permission to alter this quarter type. All other quarter types have this behaviour and are additive to this functionality.
As opposed to plots, you can ''not'' change individual build/destroy/switch/item per quarter. Instead, you can choose to trust or not trust other players with full access to the quarter. The commands <code>/q trust add</code> and <code>/q trust remove</code> are used to manage who to trust with the quarter. Furthermore, you may change quarter type which also changes what type of permissions players in the quarter have. Read more about quarter types below.<syntaxhighlight lang="java">
INFO: Quarter permissions override the underlying plot permissions.
</syntaxhighlight>


=== Commons ===
== Quarter types​ ==
The commons quarter type allows players to switch and item use within the quarter. By default these extra permissions are only granted to residents of the town the quarter is in but this can be extended to non-residents by setting the quarter to an embassy using <code>/quarters toggle embassy</code>.
All quarter types are additive to the functionality of the default apartment type. Mayors and councillors can change a quarter's type with <code>/q type {type}</code>.
{| class="wikitable"
!Quarter Type
!Description
|-
|Apartment
|The default quarter type. The owner, trusted users, and those with permissions in the underlying town plot can alter this quarter type.
|-
|Commons
|Permits any resident in the quarter's town to use switches and items within its bounds. Extendable to all players as an embassy.
|-
|Shop
|Allows for the creation of shops, regardless of the underlying plot's shop status.
|-
|Station
|Enables residents of the quarter's town to place, use, and destroy boats and minecarts within its bounds. Extendable to all players.
|}


=== Shop ===
== Sell or buy quarters​ ==
This will allow players to create shops within the quarter, keep in mind that the functionality of this relies on the shop plugin itself supporting Quarters or support for the shop plugin being added into Quarters.
To sell a quarter, stand within its bounds and type <code>/q sell {price}</code>, a player can then purchase it using <code>/q claim</code> while standing inside it. To sell to a player who is not a resident of the quarter's town, you must first turn the quarter into an embassy using <code>/q toggle embassy</code>. If the quarter's embassy status is removed the non-resident owner's ownership will be revoked.


=== Station ===
== Commands​ ==
The station type allows players to place, destroy and use boats and minecarts within the quarter. By default this only applies to residents of the town the quarter is in but much like the commons type, this functionality can be extended to all players by setting the quarter as an embassy using <code>/quarters toggle embassy</code>.
<syntaxhighlight lang="java">
PREMIUM COLOUR FEATURE: Players with Premium can change a quarter's particle outline colour with /q colour {r} {g} {b}. The 3 arguments are integer values between 0-255 representing an RGB colour.
</syntaxhighlight>
{| class="wikitable"
!Command
!Action
|-
|/q claim
|Claim a quarter that is for sale.
|-
|/q create
|Turn a selected area into a quarter.
|-
|/q delete
|Delete the quarter you are currently standing in.
|-
|/q evict
|Evict the owner of the quarter you are standing in.
|-
|/q here
|View information about the quarter you are standing in.
|-
|/q pos1 & pos2
|Command bypass to set positions without a wand.
|-
|/q add
|Adds a selected cuboid to your current selection.
|-
|/q remove
|Removes the cuboid you are standing in from your current selection.
|-
|/q sell {price}
|Put a quarter up for sale with the specified price.
|-
|/q toggle embassy
|Toggle a quarter's embassy status on or off.
|-
|/q trust add
|Add a resident as trusted in a quarter, granting them the same permissions as the owner.
|-
|/q trust remove
|Remove a resident's trusted status in a quarter.
|-
|/q trust clear
|Remove all trusted residents from a quarter.
|-
|/q type {type}
|Change a quarter's type to the specified category.
|-
|/q unclaim
|Relinquish ownership of a quarter.
|-
|/q colour {r} {g} {b}
|Change a quarter's particle outline colour. The arguments represent an RGB colour.
|}

Latest revision as of 05:03, 10 February 2024

Quarters extends the functionality of towns and plots to allow the creation of apartments. Standard plots are restricted to a simple grid-based system that requires allowing and restricting permissions of an entire chunk. Quarters can instead allow for dynamically sized cuboids in which permissions can be edited.

Creating a quarter

To create a quarter you need to be the mayor or councillor, then you can select two positions using flint, this is the "wand" item in Quarters. With two positions selected, an outline of a cuboid will appear showing your selection while you are holding the wand. To proceed type /q selection add, if you would like to add more cuboids to your selection, repeat selecting two positions and adding them with the same command.

TIP: If you cannot get access to a flint you can use /q pos1 and /q pos2 to select at your feet.

With your cuboids selected run the command /q create, if you have the necessary permissions this will turn all your selected cuboids into a quarter. These cuboids will all share a particle outline and permissions.

Quarter prerequisites​

The following requirements must be met in order to create a quarter:

  • The quarter is entirely within a single town
  • There is no wilderness within any of the cuboid's bounds
  • Your selected cuboids do not overlap with any pre-existing cuboids

Existing quarters will be deleted if any of the above requirements are no longer true, for example if the underlying town block is unclaimed or the town is deleted.

Permission management​

As opposed to plots, you can not change individual build/destroy/switch/item per quarter. Instead, you can choose to trust or not trust other players with full access to the quarter. The commands /q trust add and /q trust remove are used to manage who to trust with the quarter. Furthermore, you may change quarter type which also changes what type of permissions players in the quarter have. Read more about quarter types below.

INFO: Quarter permissions override the underlying plot permissions.

Quarter types​

All quarter types are additive to the functionality of the default apartment type. Mayors and councillors can change a quarter's type with /q type {type}.

Quarter Type Description
Apartment The default quarter type. The owner, trusted users, and those with permissions in the underlying town plot can alter this quarter type.
Commons Permits any resident in the quarter's town to use switches and items within its bounds. Extendable to all players as an embassy.
Shop Allows for the creation of shops, regardless of the underlying plot's shop status.
Station Enables residents of the quarter's town to place, use, and destroy boats and minecarts within its bounds. Extendable to all players.

Sell or buy quarters​

To sell a quarter, stand within its bounds and type /q sell {price}, a player can then purchase it using /q claim while standing inside it. To sell to a player who is not a resident of the quarter's town, you must first turn the quarter into an embassy using /q toggle embassy. If the quarter's embassy status is removed the non-resident owner's ownership will be revoked.

Commands​

PREMIUM COLOUR FEATURE: Players with Premium can change a quarter's particle outline colour with /q colour {r} {g} {b}. The 3 arguments are integer values between 0-255 representing an RGB colour.
Command Action
/q claim Claim a quarter that is for sale.
/q create Turn a selected area into a quarter.
/q delete Delete the quarter you are currently standing in.
/q evict Evict the owner of the quarter you are standing in.
/q here View information about the quarter you are standing in.
/q pos1 & pos2 Command bypass to set positions without a wand.
/q add Adds a selected cuboid to your current selection.
/q remove Removes the cuboid you are standing in from your current selection.
/q sell {price} Put a quarter up for sale with the specified price.
/q toggle embassy Toggle a quarter's embassy status on or off.
/q trust add Add a resident as trusted in a quarter, granting them the same permissions as the owner.
/q trust remove Remove a resident's trusted status in a quarter.
/q trust clear Remove all trusted residents from a quarter.
/q type {type} Change a quarter's type to the specified category.
/q unclaim Relinquish ownership of a quarter.
/q colour {r} {g} {b} Change a quarter's particle outline colour. The arguments represent an RGB colour.
Retrieved from "https://wiki.earthmc.net/index.php?title=Quarters&oldid=237041"