Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugins:towny [2025/02/14 03:12] – [Town Mayors] jasper | plugins:towny [2025/03/07 00:34] (current) – created wingurr | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== Towny Commands |
- | Towny is a plugin that allows players to create and join towns. Each town is run by a mayor who may have assistants to help with town duties. Towny protects areas through a land claim system that claims by chunk (16x16 area). Players that join towns will have their own plot or residence that they can build on within the town. Each town has an upkeep cost that must be met to keep the town standing. | + | ===== /towny ===== |
- | ===== Plots ===== | ||
- | Towny provides land claims based on the Minecraft chunk system. Each claimed plot is one chunk, 16 by 16 blocks, protected from bedrock to buildlimit. You can see chunks in-game by pressing the F3 and Gkeys at the same time. If you are on a laptop, or are using a smaller keyboard pressing F3 might also require | + | Here are the basic Towny commands. |
- | When claiming land as a mayor or a town plot as a resident, this is the smallest unit of land that can be dealt in. | + | * ? - Shows more of the Towny commands. |
+ | * prices - Shows the taxes and costs tied to running | ||
+ | * time - Shows time until a new day has become. A new day = tax / upkeep collection. | ||
+ | * map - Shows the Towny Map (it is shown as chunk markers). | ||
+ | * top residents (all/ | ||
+ | * top land (all/ | ||
+ | * top balance (all/ | ||
+ | ===== /plot ===== | ||
- | ====== Residents ====== | ||
- | This section of the guide is for players that are joining or have joined an established town (i.e., you are a resident of the town). | ||
- | ===== Town Rules & Taxes ===== | + | Here are the /plot commands. |
- | Towns may impose additional rules that residents must abide by, as long as these additional rules are not in conflict with [[https://zodiaccraft.net/rules/ | + | * ? – Shows more plot commands. |
+ | * claim – Resident command to claims a plot | ||
+ | * claim auto – claim plots that are for sale | ||
+ | * unclaim – Resident command to unclaim personally owned plots. | ||
+ | * unclaim circle/rect – unclaim owned plots in a circle or rectangle shape. | ||
+ | * unclaim (# (radius around current position)) – Radius of area to unclaim. | ||
+ | * forsale/ | ||
+ | * forsale/fs circle/rect – Set a shape. | ||
+ | * forsale/fs (# (radius around current position)) – Radius of area to set forsale. | ||
+ | * notforsale/ | ||
+ | * set reset – Sets a shop/ | ||
+ | * set shop – Sets a plot to a shop plot. | ||
+ | * set embassy – Sets a plot to an embassy plot. | ||
+ | * set arena – Sets a plot to an arena plot. | ||
+ | * set wilds – Sets a plot to a wilds plot. | ||
+ | * set inn – Set a plot to an inn plot. | ||
+ | * set name – allows a mayor or plot-owner to rename plots they own, overwriting | ||
+ | * perm – Shows the permission of the plot that the player is standing on | ||
+ | * set perm (resident/ | ||
+ | * set perm (build/ | ||
+ | * set perm (resident/ | ||
+ | * set perm reset – Resets the plot in which you are standing on to the original perms | ||
+ | * toggle | ||
+ | * toggle fire – Turn on/off firespread in the plot in which you stand. Please note this will have no effect, as firespread is disabled serverwide. | ||
+ | * toggle pvp – Turn on/off pvp in the plot in which you stand. | ||
+ | * toggle explosion – Turn on/off explosions in the plot in which you stand. | ||
+ | * toggle mob – Turn on/off hostile mobspawning in the plot in which you stand. | ||
- | Towns can also institute a tax for residents to collect funds for town upkeep and expansion. This tax is collected automatically, | + | ===== /resident ===== |
- | ===== Joining and Leaving Towns | / | + | Here shows the player their resident screen. |
- | To join a town, you must first be invited by the mayor or one of their assistants. Once you've been invited, you can join the town by running | + | * ? – Shows /res commands available. |
+ | * (resident) – Shows a player another player’s resident screen. | ||
+ | * friend add (resident) – Resident adds online player to their friends list. | ||
+ | * friend add+ (resident) – Resident adds offline player to their friends list. | ||
+ | * friend remove (resident)– Resident removes online player from their friends list. | ||
+ | * friend remove+ (resident)– Resident removes offline player from their friends list. | ||
+ | * friend clearlist – Removes all friends from a resident’s friend list. | ||
+ | * toggle map – Turns on map which refreshes when moving across plot borders. | ||
+ | * toggle townclaim – Turns on mode where /town claim is automatically used when moving across plot borders. | ||
+ | * toggle plotborder – Turns on smokey plot-border view. Border shows when players cross to different townblocks. | ||
+ | * toggle reset – This turns off all modes that are active. | ||
+ | * set perm (friend/ | ||
+ | * set perm (build/ | ||
+ | * set perm (friend/ | ||
+ | * set perm reset – This takes the perm line seen in the /resident screen and applies it to all plots personally owned by the player typing it. | ||
- | If you've received invitations to join multiple towns at the same time, you can specify which invitation you'd like to accept to avoid joining the wrong town by accident. To do this, simply add the town name to the ''/ | + | ===== /town ===== |
- | Leaving a town is simple as well. Just run /town leavein-game to leave your current | + | Here shows the player their town' |
- | < | + | * ? – 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 (page #) – Lists towns. | ||
+ | * plots (townname) – Shows a helpful list of plots and their types/ | ||
+ | * new (townname) – Creates new town. | ||
+ | * delete - Deletes your town | ||
+ | * add (resident) – Mayor command to add residents to your town. | ||
+ | * kick (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. This town will need to be in your nation. | ||
+ | * claim – claims the townblock in which you are standing on | ||
+ | * claim outpost – Claims an outpost for your town. | ||
+ | * claim (# (radius around current position)) – Claims an area of townblocks around you | ||
+ | * claim 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. | ||
+ | * unclaim all – Mayor command to unclaim all townblocks. | ||
+ | * unclaim (# (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. | ||
+ | * outpost | ||
+ | * ranklist – Displays residents and their ranks. | ||
+ | * rank (add|remove) (playername) (rankname) – Grants or removes a rank to a resident of the town. | ||
+ | * reslist – See a full list of residents in your town. | ||
+ | * set board (message) – Sets message seen by residents upon logging in. | ||
+ | * set mayor (resident) – Mayor command to give mayor status to another resident. | ||
+ | * set homeblock – Sets the homeblock and spawn of your town. | ||
+ | * set spawn – Sets the town spawn, must be done inside the homeblock. | ||
+ | * set name (name) – Change your town’s name. | ||
+ | * set outpost – Sets a townblock as an outpost. | ||
+ | * set perm (resident/ | ||
+ | * set perm (build/ | ||
+ | * set perm (resident/ | ||
+ | * set perm reset – This takes the perm line seen in the /town screen and applies it to all plots owned by the town. | ||
+ | * toggle mobs – Turn on/off hostile mobspawning in town. | ||
+ | * toggle public – Turn on/off the co-ordinates of the town’s homeblock in the /town screen. | ||
+ | * toggle pvp – Turn on/off pvp in town. | ||
- | Make sure to remove all your belongings from a town before leaving, as you will immediately lose access to your plot when you leave your town. | + | ===== /nation ===== |
- | + | ||
- | </ | + | |
- | ===== Checking Town Information | /town | + | |
- | + | ||
- | You can see information about the town you're currently in using the ''/ | + | |
- | ===== Claiming and Unclaiming Plots | /plot claim , /plot unclaim | + | |
- | + | ||
- | Once you've joined a town, you'll need a place to stay. You can claim a plot with the ''/ | + | |
- | + | ||
- | < | + | |
- | + | ||
- | If your plot is more than one chunk in size, you will have to stand in each chunk and run /plot claimin-game, | + | |
- | + | ||
- | </ | + | |
- | + | ||
- | When you're moving, or if you've accidentally claimed the wrong plot, you can unclaim a plot using the ''/ | + | |
- | ===== Managing Plot Permissions | /plot set perm , /plot perm , / | + | |
- | + | ||
- | By default only you and town staff will be able to build on your plot. To allow other people to build on your land you can set plot permissions using the ''/ | + | |
- | To use this command you first have to specify which group of players you wish to set a permission for. The available groups are: | + | |
- | + | ||
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | Once you've decided who you're going to be setting a permission for, you have to decide what permission to give that group. You can choose between: | + | |
- | + | ||
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | < | + | |
- | + | ||
- | Giving the '' | + | |
- | + | ||
- | </ | + | |
- | + | ||
- | Once you've decided who to give what permission to, all you have to do is run /plot set perm //who// //what// on in-game, while standing in the plot you'd like to set the permission for, to enable the permission for that group. To deny a permission instead just replace '' | + | |
- | + | ||
- | You can also omit either '' | + | |
- | + | ||
- | You can also omit both '' | + | |
- | + | ||
- | To check what permissions are currently set on a plot, you can use the ''/ | + | |
- | + | ||
- | < | + | |
- | + | ||
- | You can also set permissions for all your owned plots using the ''/ | + | |
- | + | ||
- | </ | + | |
- | + | ||
- | Managing your friends list can be done with the ''/ | + | |
- | + | ||
- | ===== Town Chat | / | + | |
- | + | ||
- | Each town gets access to their own private chat channel. You can access it using the ''/ | + | |
- | + | ||
- | < | + | |
- | + | ||
- | While some chat related rules are relaxed in town chat, for example you're allowed to speak any language in town chat, all [[https:// | + | |
- | Please make sure you're familiar with the [[https:// | + | |
- | + | ||
- | </ | + | |
- | + | ||
- | Just because it wasn't said in global chat doesn' | + | |
- | + | ||
- | </ | + | |
- | ====== Town Mayors ====== | + | |
- | + | ||
- | This section of the guide is for players that are creating and running their own town (i.e., you are the mayor of a town). | + | |
- | + | ||
- | <WRAP center round box 80%> | + | |
- | Creating and running a town is subject to a few rules. \\ Make sure to familiarize yourself with these [[https:// | + | |
- | </ | + | |
- | ===== Town Rules ===== | + | |
- | + | ||
- | As a mayor you're allowed to set town rules that residents of your town must abide by. These rules cannot be in opposition with server rules (i.e., you cannot allow something that is disallowed in the server rules, nor can you reduce waiting periods related to resident eviction or protection removal). | + | |
- | + | ||
- | You must post these rules in a location easily accessible by your residents and Vestria Server Staff, as well as inform every resident that you invite to your town about your town rules and where to find them. | + | |
- | + | ||
- | When you make a change to your town rules, you must notify all your residents of the changes to the town rules. From the moment you provide the notice to your residents, they have a 48 hour grace period to make sure they are in compliance with your new town rules. | + | |
- | + | ||
- | < | + | |
- | + | ||
- | It is your responsibility as a mayor to ensure every town member receives notice of town rules changes, and that you can provide documentation for this notice being sent. | + | |
- | + | ||
- | </ | + | |
- | + | ||
- | If a town member breaks town rules, you can evict them without notice. **You must allow the player to retrieve all of their belongings.** | + | |
- | + | ||
- | ===== Town Bank ===== | + | |
- | + | ||
- | Owning a town requires paying upkeep to the server. Your upkeep cost goes up with the amount of residents you have and gets taken out of your town bank every day. It's important to keep enough funds in your town bank to survive for a couple of days, since your town will fall if you run out of funds. | + | |
- | + | ||
- | ==== Depositing and Withdrawing Town Funds | /town deposit | + | |
- | + | ||
- | Every town member can deposit funds into your town bank, but only the mayor can withdraw from the town bank. | + | |
- | + | ||
- | Run /town deposit //amount// in-game to deposit '' | + | |
- | + | ||
- | < | + | |
- | + | ||
- | Make sure to leave enough funds in the town bank at all times to make it through a couple of days. You never know when you won't be able to get online due to unforeseen circumstances. | + | |
- | + | ||
- | </ | + | |
- | ==== Checking Bank History | /town bankhistory | + | |
- | + | ||
- | To see who has deposited and withdrawn money from the town bank you can use the ''/ | + | |
- | + | ||
- | ===== Taxes ===== | + | |
- | + | ||
- | Taxes are a way for you as a mayor to gather funds from your residents for town upkeep and expansion. When you set up taxes through the Towny plugin, the taxes will be automatically deducted from your residents balances and deposited into the town bank. | + | |
- | + | ||
- | You can set up different taxes: | + | |
- | + | ||
- | * collect a flat fee from each resident per day | + | |
- | * collect a percentage of a residents balance per day | + | |
- | * collect a fee per plot a resident owns | + | |
- | + | ||
- | ==== Setting Taxes | /town set taxes , /town toggle taxpercent | + | |
- | + | ||
- | Collecting taxes from your residents is easy, run /town set taxes //amount// in-game. This will start collecting a daily tax of '' | + | |
- | + | ||
- | ==== Setting Plot Taxes | /town set plottax | + | |
- | + | ||
- | As a mayor you can also set up a tax per plot a resident owns, to enable this run /town set plottax //amount// in-game. This will collect taxes totalling '' | + | |
- | + | ||
- | The above command only sets the tax for normal plots, you can set a different tax for each plottype using the ''/ | + | |
- | + | ||
- | ===== Town Management ===== | + | |
- | + | ||
- | ==== Creating and Deleting a Town | /town create | + | |
- | + | ||
- | Aspiring mayors can create a new town with the ''/ | + | |
- | + | ||
- | < | + | |
- | + | ||
- | Town creation costs **$5, | + | |
- | + | ||
- | </ | + | |
- | + | ||
- | Once you're ready to create your town, run /town create NameOfTownin-game and your town will be created (assuming you have the required funds of course). | + | |
- | + | ||
- | If you no longer want to keep running your town, you can disband it using the ''/ | + | |
- | + | ||
- | ==== Allowing Plots to be Claimed by Residents | /plot forsale | + | |
- | + | ||
- | To allow plots to be claimed by your residents you must set them for sale. To do this stand in the plot and run /plot forsalein-game. You can also specify a price if you would like to sell the plot to your residents, run /plot forsale //amount// in-game to allow the plot to be bought for '' | + | |
- | + | ||
- | You can make plots unclaimable again by standing in them and running /plot notforsalein-game. | + | |
- | + | ||
- | ==== Changing Town Settings | /town set | + | |
- | + | ||
- | Towns have quite a few settings that can be changed using the ''/ | + | |
- | + | ||
- | With the ''/ | + | |
- | + | ||
- | The ''/ | + | |
- | + | ||
- | You can change the name of your town as well, with the ''/ | + | |
- | + | ||
- | You can post announcements to your residents in your town board, with the ''/ | + | |
- | + | ||
- | < | + | |
- | + | ||
- | There are more settings you can change for your town that are not listed here, run /town setin-game to see a list of all settings you can change. | + | |
- | + | ||
- | </ | + | |
- | ==== Claiming and Unclaiming Land | /town claim , /town unclaim | + | |
- | + | ||
- | To expand your town you have to claim additional chunks, or plots, for residents to be able to build on. | + | |
- | + | ||
- | This works the same as residents claiming plots from the town as described [[https:// | + | |
- | + | ||
- | ==== Managing Claimed Plots | /plot set | + | |
- | + | ||
- | Like towns as a whole, plots also have settings you can change as the mayor. The two main settings that can be changed are the plot name and plot type. | + | |
- | + | ||
- | To set a name for your plot, run /plot set NameOfPlotin-game while standing in the plot you wish to change the name of. This can be useful for designating roads or other important town buildings. \\ To change the plot type of a plot, run /plot set //type// in-game, where type is one of: | + | |
- | + | ||
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | Once again you can see all settings available for plots by running /plot setin-game. | + | |
- | + | ||
- | ==== Managing Residents | /town invite | + | |
- | + | ||
- | After creating and setting up your town, you can invite, remove, and rank up residents. | + | |
- | + | ||
- | To invite players to your town, run /town invite Playerin-game to invite Player to your town. \\ To kick a player from your town, run /town kick Playerin-game to remove Player from your town. | + | |
- | + | ||
- | To see all residents currently a part of your town, run /town reslistin-game. | + | |
- | + | ||
- | You can promote residents of your town to different ranks within your town with the ''/ | + | |
- | + | ||
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | Run /town rank add Player //rank// in-game to add '' | + | |
- | + | ||
- | You can see which players have which ranks with the ''/ | + | |
- | + | ||
- | ==== Managing Town Permissions | /town set perm | + | |
- | + | ||
- | Once again this works very similar to setting plot permissions for residents, explained [[https:// | + | |
- | + | ||
- | ===== Outposts and Nations ===== | + | |
- | + | ||
- | * Towns must have 5 residents to unlock their first outpost | + | |
- | * Towns must have 7 residents to join a nation | + | |
- | + | ||
- | ====== Nation Kings ====== | + | |
- | + | ||
- | This section of the guide is for players that are creating and running their own nation (i.e., you are the king of a nation). | + | |
- | + | ||
- | < | + | |
- | + | ||
- | Nations may have up to 5 towns! | + | |
- | + | ||
- | </ | + | |
- | ===== Nation Bank ===== | + | |
- | + | ||
- | Similar to towns, nations are also required to pay upkeep to the server. This upkeep fee goes up the more residents are in a nation and is automatically withdrawn from the nation bank once a day. Just like towns, nations too will fall should they run out of funds. Make sure to keep your nation bank topped up enough to make it through a few days! | + | |
- | + | ||
- | ==== Depositing and Withdrawing Nation Funds | / | + | |
- | + | ||
- | Every nation member can deposit funds into your nation bank, but only the king can withdraw from the nation bank. | + | |
- | + | ||
- | Run /nation deposit //amount// in-game to deposit '' | + | |
- | + | ||
- | < | + | |
- | + | ||
- | Make sure to leave enough funds in the nation bank at all times to make it through a couple of days. You never know when you won't be able to get online due to unforeseen circumstances. | + | |
- | + | ||
- | </ | + | |
- | ==== Checking Bank History | / | + | |
- | + | ||
- | To see who has deposited and withdrawn money from the nation bank you can use the ''/ | + | |
- | + | ||
- | ===== Taxes | / | + | |
- | + | ||
- | Nations can tax their member towns, similar to how towns can tax their residents. Nation Kings can set up taxes by running /nation set taxes //amount// in-game, this will withdraw '' | + | |
- | + | ||
- | ===== Nation Management ===== | + | |
- | + | ||
- | ==== Creating and Deleting a Nation | / | + | |
- | + | ||
- | Aspiring kings can create a new nation, once they meet the requirements, | + | |
- | + | ||
- | < | + | |
- | + | ||
- | Nation creation costs **$250, | + | |
- | + | ||
- | </ | + | |
- | + | ||
- | Once you're ready to create your nation, run /nation create NameOfNationin-game and your nation will be created (assuming you have the required funds of course). | + | |
- | + | ||
- | If you no longer want to keep running your nation, you can disband it using the ''/ | + | |
- | + | ||
- | ==== Changing Nation Settings | / | + | |
- | + | ||
- | Just like towns, nations also have settings you can change as the king. \\ Some settings will be similar or the same as the [[https:// | + | |
- | + | ||
- | Once again you can see a list of all available settings by running /nation setin-game. | + | |
- | + | ||
- | ==== Managing Member Towns | / | + | |
- | + | ||
- | After creating and setting up your nation, you can invite and remove member towns, and rank up residents within your nation. | + | |
- | + | ||
- | To invite a town to your nation, run /nation invite NameOfTownin-game to invite NameofTown to your nation. \\ To kick a town from your nation, run /nation kick NameOfTownin-game to remove NameOfTown from your nation. | + | |
- | + | ||
- | To see all towns currently a part of your town, run /nation townlistin-game. | + | |
- | + | ||
- | You can promote residents of your nation to different ranks within your nation with the ''/ | + | |
- | + | ||
- | * '' | + | |
- | * '' | + | |
- | Run /nation rank add Player //rank// in-game to add '' | + | |
- | + | ||
- | You can see which players have which ranks with the '' | + | |
- | + | ||
- | ====== Tips & Tricks ====== | + | |
- | + | ||
- | ===== Towny Prices | / | + | |
- | + | ||
- | To quickly see prices related to towny features, you can use the ''/ | + | |
+ | Here shows the player their nation' | ||
+ | * ? – Shows /nation commands. | ||
+ | * list {page #} – 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. | ||
+ | * add (town) – Invites/ | ||
+ | * kick (town) – Removes a town from your nation. | ||
+ | * delete – Deletes your nation. | ||
+ | * ally add (nation) – Add a nation to your nation’s ally list. | ||
+ | * ally remove (nation) – Removes a nation from your nation’s ally list. | ||
+ | * enemy add (nation) – Add a nation to your nation’s enemy list. | ||
+ | * enemy remove (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. | ||
+ | * set capital {town} – Sets the capitol and king of the nation. | ||
+ | * set name {name} – Sets the nation’s name. |