Quarters?
Quarters is an addon for Towny that uses the Towny API to allow for the creation of 3D areas named quarters (as in "living quarters") within towns independent of the grid-based plot system Towny uses.
This allows for much finer control over what property players can give their residents. Additionally there is a range of different types that extend the functionality of quarters such as stations allowing for the placement, destruction and use of boats and minecarts, or the commons type which allows players to switch and item use within the quarter.
In testing, Quarters has been shown to be able to make a town feel much more alive. With multiple players being able to fit into a small area a town will feel much more lively and active, and it is much easier for mayors to get their residents engaged.
Standard features:
- 3D, custom shaped apartments made of as many cuboids as required
- Quarters can be owned by individual players and others can be "trusted" within them to gain access
- An array of different types to extend quarter functionality
- Particles that display the current selection and quarter positions for ease of use
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 /quarters pos1 and /quarters pos2 will suffice.
Selecting a region
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 /quarters selection add, 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 /quarters selection remove to remove it from your selection. Additionally, you can send /quarters selection clear 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.
Making a quarter from your selection
With your quarter selected, type /quarters create 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 /quarters colour {r} {g} {b}.
Quarter Types
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 /quarters type {type}
Apartment
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 behavior and are additive to this functionality.
Commons
The commons quarter type allows players to switch and item use within the quarter. It also allows players to use beds in the quarter's bounds. 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 /quarters toggle embassy.
Public
The public type allows all Towny permissions to be undertaken within it's bounds, that means players can build, destroy, switch and item use.
Shop
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.
Station
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 /quarters toggle embassy.
Worksite
The worksite type is much like the commons type but it allows players to build and destroy.
Commands
/quarters (/q)
claim: used to claim a quarter that is for sale
colour {r} {g} {b}: used to change the particle outline colour of a quarter, takes in three int values between 0-255
create: used to turn a selection into a quarter
defaultsellprice {price}: used to set the default price that quarters will sell for when using /quarters sell
delete: used to delete the quarter you are currently standing in
evict: used to evict the owner of the quarter you are standing in
here: used to view information about the quarter you are standing in
info: used to view information about the quarters plugin such as the current version
pos1 {x} {y} {z} & pos2 {x} {y} {z}: command bypass to set positions without a wand, coordinates are optional and relative to the player's position
selection: command to manage wand selections
add: adds a selected cuboid to your current selection
remove: removes the cuboid you are standing in from your current selection
clear: removes all currently selected cuboids
sell: used to put a quarter up for sale
{price}: price to sell quarter for
cancel: used to cancel a quarter sale
toggle:
constantoutlines: used to toggle particle outlines to be permanently on
embassy: used to toggle a quarter's embassy status
trust:
add: add a resident as trusted in a quarter, this will allow them the same build, switch, destroy and itemuse permissions as the owner
remove: remove a resident as trusted in a quarter
clear: remove all trusted residents from a quarter
type {type}: used to change a quarter's type
unclaim: used to relinquish ownership of a quarter