Towny

Towny  is a plugin designed to bring users together by making communitys through towns and nations. Users can join together in making a town claiming land and building buildings. Towns can then band togther becoming one big community or nation

## /towny

* /towny
	+ - Shows basic towny commands.
	+ ? - Shows more towny commands.
	+ map - Shows the towny map.
	+ prices - Shows taxes/costs associated with running a town.
	+ time - Shows time until next new-day (tax/upkeep collection.)
	+ top
		- residents {all/town/nation} - Shows top residents.
		- land {all/resident/town} - Shows top land owners.
	+ spy - Admin command to spy on all chat channels
	+ tree - Shows lots of stuff.
	+ universe - Shows full towny stats, resident/town/nation/world counts as well as townblocks claimed.
	+ v - Shows towny version.
	+ war
		- stats
		- scores

## /plot

* /plot
	+ - Shows the /plot commands.
	+ claim - Resident command to personally claims a plot that are for sale.
		- auto - Resident command to personally claim an area of plots that are for sale, around the player typing the command.
	+ unclaim - Resident command to unclaim personally owned plots.
		- circle/rect - Resident command to unclaim personally owned plots in a circle or rectangle shape.
			* {# (radius around current position)} - Radius of the area to unclaim.
	+ {forsale/fs} - Set a plot for sale.
		- circle/rect - Set a shape.
			* {# (radius around current position)} - Radius of the area to set forsale.
		- $$ - Cost of plot.
			* circle/rect - Set a shape.
				+ {# (radius around current position)} - Radius of the area to set forsale.
	+ {notforsale/nfs} - Set a plot to not be for sale.
		- circle/rect - Set a shape.
			* {# (radius around current position)} - Radius of the area to set notforsale.
	+ perm - Shows the perm line of the plot in which the player stands.
	+ 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.
		- 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
			* {on/off} - Edits the perm line of the single plot in which the player is standing. 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 - 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
		- 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.

## /resident

* /resident
	+ - Shows a player their resident screen.
	+ ? - Shows /res commands available.
	+ {resident} - Shows a player another player's resident screen.
	+ 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 - Lists residents in towny's data folder.
	+ spawn - If deny\_bed\_use: true in the config.yml 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.
		- spy - Admins can turn on chat-channel spying.
		- reset - This turns off all modes that are active.
	+ set
		- perm
			* {on/off} - Edits the perm line on the resident screen. See here for details.
			* {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

* /town
	+ - Shows a player their town's town screen.
	+ ? - Shows /town commands available.
	+ {town} - Shows a player another town's town screen.
	+ here - Shows you the town screen of the town in which you stand.
	+ leave - Leaves a town.
	+ list - Lists towns.
	+ online - Shows players in your town which are online.
	+ new
		- {townname} - Creates new town.
		- {townname} {mayor} - Admin command to create 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.
		- outpost - Claims an outpost for your town.
		- {# (radius around current position)} - Claims an area of townblocks around you for your town.
		- auto - Claims as many townblocks around you as is possible given money in townbank and available townblocks.
	+ unclaim - Mayor command to unclaim the townblock in which you stand.
		- all - Mayor command to unclaim all townblocks.
		- {# (radius around current position)} - Command to unclaim an area of townblocks around you.
	+ 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.
	+ outpost
		- {# (where # equals the corresponding outpost's number)} - Teleports to an outpost.
	+ ranklist - Displays residents and their ranks.
	+ rank {add|remove} {playername} {rankname} - Grants or removes a rank to a resident of the town.
	+ reslist - Displays a full list of residents in the town.
	+ 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.
		- name {name} - Change your town's name.
		- outpost - Sets a townblock as an outpost.
		- 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.
		- tag {upto4character} - Sets the town's tag, which is sometimes used on that chat line.
			* clear - Clears the tag set for the town.
		- taxes {$} - Sets taxes collected from each resident daily. Also sets percentage if taxpercent is toggled on.
		- 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.
	+ 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.
	+ join {townname} - Command to join a town that doesn't require invites.

## /nation

* /nation
	+ - Shows a player their nation's nation screen.
	+ ? - Shows /nation commands.
	+ list - Lists nations.
	+ online - Shows players in your nation which are online.
	+ {nation} - Shows a player the /nation screen of another nation.
	+ leave - Mayor command to leave the nation they are a part of.
	+ withdraw {$} - King command to remove money from the nation bank.
	+ deposit {$} - King command to add money to the nation bank.
	+ new
		- {nationname} - Mayor command to create a nation.
		- {nationname} {capitaltown} - Admin command to create a new nation, set capitol.
	+ rank - Command to set assistant/custom ranks in the nation.
	+ add {town} .. {town} - Invites/Adds a town to your nation.
	+ kick {town} .. {town} - Removes a town from your nation.
	+ delete {nation} - Deletes your nation.
	+ 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.
	+ rank {add|remove} {playername} {rankname} - Grants or removes a rank to a resident of the nation.
	+ set
		- king {resident} - King command to change the king of the nation.
		- captial {town} - Sets the capitol and king of the nation.
		- taxes {$} - Sets nationtax applied to the towns within the nation.
		- name {name} - Sets the nation's name.
		- 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.
		- tag {upto4character} - Sets the nation's tag, which is sometimes used on that chat line.
			* clear - Clears the tag set for the nation.
	+ toggle
		- neutral - Sets whether your nation will pay daily to be neutral during towny war.