Towny

## Overview

Towny is used to maintain a town and eventually grow to be an empire. It is absolutely essential to understand the basics to thrive.

### Commands

Commands are essential to run towny. They have been organized to make it simpler.

#### /plot

ex: /plot claim

* claim - Resident command to personally claims a plot that are for sale.
* unclaim - Resident command to unclaim personally owned plots.
* forsale/fs - Set a plot for sale.
* notforsale/nfs - Set a plot to not be for sale.
* evict - Used to remove a plot from a plot owner, usually by the mayor or assistant.
* perm - Shows the perm line of the plot in which the player stands.
* perm hud - Toggles on/off the plot perm hud scoreboard which shows the perm line of the plot in which the player stands along with more useful plot info
* set
	+ reset - Sets a shop/embassy/arena/wilds plot back to a normal plot.
	+ shop - Sets a plot to a shop plot.
	+ embassy - Sets a plot to an embassy plot.
	+ arena - Sets a plot to an arena plot.
	+ wilds - Sets a plot to a wilds plot.
	+ inn - Set a plot to an inn plot.
	+ jail - Set a plot to an jail plot.
	+ farm - Set a plot to a farm plot.
	+ bank - Set a plot to a bank plot.
	+ name - allows a mayor or plot-owner to rename plots they own, overwriting the ~Unowned message. Personal-plots display both the plot's given name and the name of the plot-owner.
	+ perm (ex: /set perm resident build on)
		- {on/off} - Edits the perm line of the single plot in which the player is standing. (See Perms in table of contents)
		- {resident/ally/outsider} {on/off}
		- {build/destroy/switch/itemuse} {on/off}
		- {resident/ally/outsider} {build/destroy/switch/itemuse} {on/off}
		- reset - Resets the plot in which you stand to the default perm line of the /town or /resident screen (depending on if the plot is owned personally or by the town.)
	+ toggle (ex: /set toggle fire)
		- fire - Turn on/off firespread in the plot in which you stand.
		- pvp - Turn on/off pvp in the plot in which you stand.
		- explosion - Turn on/off explosions in the plot in which you stand.
		- mob - Turn on/off hostile mobspawning in the plot in which you stand.
	+ clear - Command to remove list of block id's from a plot, used by a mayor on town-owned land, or by a plot-owner on their personal plots.
	+ group (ex: /set group create ExampleName
		- add|new|create {groupname} - Creates a plot group where a player is standing, also adds plots to an existing group.
		- remove - Removes the plot stood in from its plot group.
		- rename {newname} - Renames a plot group.
		- set {plottype} - Sets the group to a specified plot type. Not able to be used for Jail plots.
		- set perm ... - Used to set the perm line of the group you are standing in. See above section for /plot set perm for remainder of commands.
		- toggle ... - Used to toggle plot settings. See above section for /plot set toggle for remainder of commands.
		- forsale|fs {price} - Set the group for sale at the set price.
		- notforsale|nfs - Set the group not for sale.

#### /resident

ex: /resident add Herobrine

* friend
	+ add {resident} .. {resident} - Resident adds online player to their friends list.
	+ add+ {resident} .. {resident} - Resident adds offline player to their friends list.
	+ remove {resident} .. {resident} - Resident removes online player from their friends list.
	+ remove+ {resident} .. {resident} - Resident removes offline player from their friends list.
	+ clearlist - Removes all friends from a resident's friend list.
	+ list - Returns a list of your friends.
* list - Lists residents in towny's data folder who are online.
* jail paybail - Allows a player to pay to get out of jail. Funds go to the town which owns the Jail.
* spawn - If deny\_bed\_use: true and player has a current bed spawn, command will teleport player to their bed.
* toggle
	+ map - Turns on map which refreshes when moving across plot borders.
	+ townclaim - Turns on mode where /town claim is automatically used when moving across plot borders.
	+ plotborder - Turns on smokey plot-border view. Border shows when players cross to different townblocks.
	+ constantplotborder - Turns on smokey plot-border view. Border doesn't disappear.
	+ spy - Admins can turn on chat-channel spying.
	+ ignoreplots - Turns on/off plot notifications in town.
	+ reset - This turns off all modes that are active.
* set
	+ {on/off} - Edits the perm line on the resident screen. (See Perms in Contents for more info)
	+ {friend/ally/outsider} {on/off}
	+ {build/destroy/switch/itemuse} {on/off}
	+ {friend/ally/outsider} {build/destroy/switch/itemuse} {on/off}
	+ reset - This takes the perm line seen in the /resident screen and applies it to all plots personally owned by the player typing it.
* tax - Shows taxes a player pays.

#### /town

ex: /town add Herobrine

* list
	+ by name {page #} - order alpabetically.
	+ by resident {page #} - order by town with most residents.
	+ by balance {page #} - order by town with the highest nation bank balance.
	+ by townblocks {page #} - order towns by how many townblocks they have claimed
	+ by online {page #} - order by how many players are online at that moment.
	+ by open {page #} - lists only open towns, in order of most residents to least residents.
* online - Shows players in your town which are online.
* plots {townname} - Shows a helpful list of plots and their types/revenue which are owned by the town.
* new {townname} - Creates a new town.
* add {resident} .. {resident} - Mayor command to add residents to your town.
* kick {resident} .. {resident} - Mayor command to remove residents from your town.
* spawn - Teleports you to your town's spawn.
* spawn {town} - Teleports you to another town's spawn.
* claim - Mayor command to claim the townblock in which you stand for your town.
* unclaim - Mayor command to unclaim the townblock in which you stand.
* withdraw {$} - Removes money from town bank.
* deposit {$} - Adds money from player to the town bank.
* buy
	+ bonus {amount} - Buys available bonus townblocks.
* delete {town name} - Admin/Mayor command to delete a town from towny's data folder's files.
* outlawlist {town} - Displays a list of outlaws for a town.
* outlaw {add/remove} {name} - Adds or removes an outlaw from a town's outlaw list
* ranklist - Displays residents and their ranks.
* rank {add|remove} {playername} {rankname} - Grants or removes a rank to a resident of the town.
* reslist {townname} - See a FULL list of all residents in a town.
* say {msg} - Broadcast a message to online town members.
* set
	+ board {message} - Sets message seen by residents upon logging in.
	+ mayor {resident} - Mayor command to give mayor status to another resident.
	+ homeblock - Sets the homeblock and spawn of your town.
	+ spawn - Sets the town spawn, must be done inside the homeblock.
	+ spawncost - Set the cost of spawning to a public town. Doesn't affect town residents, nation members and nation-allies.
	+ name {name} - Change your town's name.
	+ jail - Resets a jail plot's spawn to current position within a jail plot.
	+ perm
		- {on/off} - Edits the perm line on the town screen. See here for details.
		- {resident/ally/outsider} {on/off}
		- {build/destroy/switch/itemuse} {on/off}
		- {resident/ally/outsider} {build/destroy/switch/itemuse} {on/off}
		- reset - This takes the perm line seen in the /town screen and applies it to all plots owned by the town.
	+ taxes {$} - Sets taxes collected from each resident daily. Also sets percentage if taxpercent is toggled on.
	+ taxpercentcap {$} - The maximum amount that can be taken when taxpercent is enabled.
	+ plottax {$} - Set taxes collected from each resident daily, per plot that they own.
	+ plotprice {$} - Sets default cost of plot for the town.
	+ shopprice {$} - Sets default cost of a shopplot for the town.
	+ shoptax {$} - Set taxes collected from each resident daily, per shopplot that they own.
	+ embassyprice {$} - Sets default cost of a embassy plot for the town.
	+ embassytax {$} - Set taxes collected from each resident daily, per embassy plot that they own.
	+ title {name} {titlegoeshere} - Mayor command to add a Title to a member of the town.
	+ surname {name} {surnamegoeshere} - Mayor command to add a Suffix to a member of the town.
	+ toggle
		- explosion - Turn on/off explosions in town.
		- fire - Turn on/off firespread in town.
		- mobs - Turn on/off hostile mobspawning in town.
		- public - Turn on/off public /town spawning and the co-ordinates of the town's homeblock in the /town screen.
		- pvp - Turn on/off pvp in town.
		- taxpercent - Turn on/off taxing by percent/flatrate.
		- open - Turn on/off public joining to your town.
		- jail {number} {residentname} - Sends a resident of your town to the jail spawn number specified. Same command unjails a player.
		- jail {number} {residentname} {days} - Sends a resident of your town to the jail spawn number specified, for the number of Towny days specified.
	+ join (townname) - Command to join a town that doesn't require invites.

#### /nation

ex: /nation add Herobrine

The commands for nation are the exact same as town except for the following commands:

* ally
	+ add {nation} .. {nation} - Add a nation to your nation's ally list.
	+ remove {nation} .. {nation} - Removes a nation from your nation's ally list.
* enemy
	+ add {nation} .. {nation} - Add a nation to your nation's enemy list.
	+ remove {nation} .. {nation} - Removes a nation from your nation's enemy list.
* set
	+ king {resident} - King command to change the king of the nation.
	+ capital {town} - Sets the capitol and king of the nation.
	+ board {message} - Sets message seen by residents upon logging in.
	+ taxes {$} - Sets nationtax applied to the towns within the nation.
	+ name {name} - Sets the nation's name.
	+ spawn - Sets the nation spawn point.
	+ spawncost - Sets the cost of public spawns to that nation's spawn point. No effect on members of the nation or nation-allies
	+ title {name} {titlegoeshere} - King command to add a Title to a member of the nation.
	+ surname {name} {surnamegoeshere} - King command to add a Suffix to a member of the nation.
	+ mapcolor {color} - Sets the colour seen on the dynmap-towny webpage.
* merge (nationname)
	+ Requests the given nation to merge into your nation.
	+ Can only be used by the nation king, and requires the king of the other nation to be online to accept the merger.
	+ The soon-to-be-ex-king will receive a confirmation message asking if they will accept the dissolution of their nati

### Perms

Perms are used to set in detail permissions for towns/nations

The 4 permission-types available are Build, Destroy, Switch and Itemuse.

* Build allows players to add blocks in your town/plot.
* Destroy allows players to remove blocks in your town/plot.
* Switch covers use of:
	+ dispensers,
	+ noteblocks,
	+ chests,
	+ furnaces,
	+ wooden and iron doors,
	+ levers,
	+ gold, iron, stone and wood pressure plates
	+ stone buttons,
	+ trapdoors,
	+ jukeboxes,
	+ redstone repeaters,
	+ gates,
	+ trapped chests,
	+ redstone comparators,
	+ beacon blocks,
	+ hoppers,
	+ droppers,
	+ item frames,
	+ Accessing minecart hoppers, minecart chests, minecart furnaces.
	+ Shulker boxes
	+ .... or any other type of block which is clicked on in some manner.
* Itemuse covers the use of:
	+ water and lava buckets,
	+ empty buckets,
	+ lighters,
	+ bonemeal and other dyes,
	+ enderpearls,
	+ placing/destroying all minecart types,
	+ firecharges,
	+ using bottles.
	+ .... or any other type of item which is used in some manner.