Get Started
Documentation
- 🖥️ Commands
- 🏙️ Towns
- 🏠 Claims
- 🔨 Roles
- 🌟 Advancements
- ☯️ Relations
- ⚔️ Wars
- 🚫 Inactive Town Pruning
Developers
- 📦 API v3
- 🧡 Towns API
- ⚙️ Claims API
- ❗ API Events
- 🕸️ API v1 (Legacy)
Towns are the social and economic core of HuskTowns, and allow users to build a society, create claims, manage relations, and if enabled even go to war. Players can either make a new town, or accept an invitation from another player to join one. You can only be in one town at a time and each town has a single mayor.
To make a town, type /town create <name>. This will make a new town at level 1 with the given name.
If your server has the towns.require_first_level_collateral setting enabled, then creating a town will cost the price of "level 1" as defined in levels.yml. The name mustn't contain any whitespace characters.
You can change the color, bio, greeting and farewell messages of your town. Each changes the way your town appears to other players.
/town color <#rgb>/town info <name> page, and on hover in the /town list. Change with /town bio <message>/town greeting <message>/town farewell <message>You can also rename the town using /town rename <name> if you've changed your mind.
All towns have a town about page, which shows a number of important pieces of information about each town, such as its level, population count, claim count, mayor, bank balance, spawn position, etc.
If you are the member of a town, running the /town command on its' own will show your town about page. If you want to view another town's about page, use /town about <name>.
You can view a list of towns using the /town list command. You can use the pagination and filter buttons to change the list sorting if a lot of towns have been made. Clicking the name of towns on this list will show their town about page.
You can send messages privately to fellow town members using /town chat <message>.
You can invite members to your town using /town invite <player>. Note you can only invite players who aren't currently the member of a town.
You can promote and demote members up and down the town role hierarchy, as it has been set up on the server. To promote a member, use /town promote <member>. Likewise, to demote a user, use /town demote <member>. Note you can't promise members to or who are an equal or higher role in the town history than yourself.
Each role in the history has associated privileges, including inherited privileges from roles lower down in the hierarchy. For example, by default, only the mayor can rename the town and only trustees can invite other members.
| Role Weight | Role Name | Privileges |
|---|---|---|
| 3 | Mayor | set_bio, evict, promote, demote, withdraw, level_up, set_rules, rename, set_color, declare_war |
| 2 | Trustee | set_farm, set_plot, manage_plot_members, trusted_access, unclaim, claim, set_greeting, set_farewell, invite, set_spawn, manage_relations, spawn_privacy, view_logs |
| 1 | Resident | deposit, chat, claim_plot, spawn |
See Roles for more information on role customisation.
To view the list of members for any given town, grouped by role, use the /town census [name] command.
If you have the privilege to do so, you can evict a member with /town evict <member>. Note you can't evict members with an equal or higher role than yourself.
If you want to leave your town, you can do so with /town leave. The mayor can't leave their own town; they must first transfer ownership or delete it instead.
The mayor of the town can transfer ownership of it to another member of the town using /town transfer <member>. They can also choose to delete the town with /town delete if they wish, which will also remove all the towns' claims.
Towns have a bank balance ("coffers") and level, which starts at 1. By levelling up your town, you can increase the maximum number of claims and members your town can have, as well as gain boosted crop growth rates and mob spawner spawn rates within your town's farm chunks.
To level up your town, you must deposit money into your town coffers using /town deposit <amount>. When your town meets the level-up threshold, you can then use /town levelup to spend money out of your town coffers to raise your town level by 1. Members with privileges can also do /town withdraw <amount> to withdraw from the town coffers at any time.
If you're the administrator, you can edit these by modifying the levels.yml file.
| Level | Upgrade Cost | Claims | Members |
|---|---|---|---|
| 1 | 2,000 | 6 | 5 |
| 2 | 4,000 | 12 | 10 |
| 3 | 8,000 | 18 | 15 |
| 4 | 16,000 | 24 | 20 |
| 5 | 32,000 | 30 | 25 |
| 6 | 64,000 | 36 | 30 |
| 7 | 128,000 | 42 | 35 |
| 8 | 256,000 | 48 | 40 |
| 9 | 512,000 | 54 | 45 |
| 10 | 1,024,000 | 60 | 50 |
| 11 | 2,048,000 | 66 | 55 |
| 12 | 4,096,000 | 72 | 60 |
| 13 | 8,192,000 | 78 | 65 |
| 14 | 16,384,000 | 84 | 70 |
| 15 | 32,768,000 | 90 | 75 |
| 16 | 65,536,000 | 96 | 80 |
| 17 | 131,072,000 | 102 | 85 |
| 18 | 262,144,000 | 108 | 90 |
| 19 | 524,288,000 | 114 | 95 |
| 20 | 1,048,576,000 | 120 | 100 |
Your town has a spawn point that you can teleport to, which must be located in one of your town claims. To set your town spawn, use /town setspawn. Members of the town can then return to it with /town spawn.
If you wish to allow members from outside your town to teleport to your town spawn, use /town privacy public to make the spawn public. Anyone can then use /town spawn <name> to pay a visit.
If you have Relations enabled, you can set relations with other towns on the server using the /town relations command.