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)
HuskTowns offers several built-in hooks providing support for other plugins.
| Name | Description | Link |
|---|---|---|
| Vault | Economy support | https://www.spigotmc.org/resources/vault.34315/ |
| LuckPerms | Permission Contexts for towns | https://luckperms.net/ |
| HuskHomes | Improved global teleportation | https://william278.net/project/huskhomes/ |
| Plan | Display town analytics in Plan | https://www.playeranalytics.net/ |
| PlaceholderAPI | Provides HuskTowns placeholders | https://placeholderapi.com/ |
| Dynmap | Add claim markers to your Dynmap | https://www.spigotmc.org/resources/dynmap.274/ |
| Pl3xMap | Add claim markers to your Pl3xMap | https://modrinth.com/plugin/pl3xmap/ |
| BlueMap | Add claim markers to your BlueMap | https://www.spigotmc.org/resources/bluemap.83557/ |
HuskTowns supports using Vault and a compatible Economy plugin to hook into your server economy to let players deposit and withdraw money into the town coffers.
HuskTowns provides additional Permission Contexts for LuckPerms, letting you restrict permission access based on contextual factors determined by HuskTowns.
If you wish to, for instance, restrict certain commands behind a player being in a town, this is how you can do so.
config.yml, ensure luckperms_contexts_hook is enabled under general.✅ See the LuckPerms Wiki for how to make use of contexts.
| Context | Description |
|---|---|
husktowns:claim-town | Name of the town claiming the player is standing in |
husktowns:in-claim | true/false; if a player is in a claim or not |
husktowns:can-build | true/false; if a player can place and break blocks |
husktowns:can-open-containers | true/false; if a player can use containers |
husktowns:can-interact | true/false; if a player can interact (right click) with blocks and entities |
husktowns:standing-in-own-town | true/false; if a player is standing in a claim owned by the town they are in |
husktowns:is-town-member | true/false; if a player is a member of a town |
husktowns:town | Name of the town the player is in |
husktowns:town-role | The player's role in their town; mayor, resident or trusted |
husktowns:town-level | The level of the town the player is in |
HuskTowns has optional support for integrating with HuskHomes to provide improved global teleportation for players when teleporting to your /town spawn.
HuskTowns supports displaying statistics about towns on your Player Analytics (Plan) web panel.
If you have PlaceholderAPI installed, HuskTowns (v2.2+) will automatically register a hook providing a number of placeholders that will be replaced with their appropriate values.
The following table contains the available placeholders. You can customize the replacement messages in the plugin locales file. If you wish to customize the Yes/No messages, please edit your PlaceholderAPI config as those are sourced from there.
| Placeholder | Replacement | Notes |
|---|---|---|
%husktowns_town_name% | Waterside | Name of town the player is in¹ |
%husktowns_town_role% | Citizen | Name of the role the player has in their town¹ |
%husktowns_town_mayor% | William278 | Name of the player's town mayor¹ |
%husktowns_town_color% | #ff1200 | Color of the player's town (gray if not in one) |
%husktowns_town_members% | Mark12, William278, MeetThePro | List of members of the player's town¹ |
%husktowns_town_member_count% | 3 | Number of members of the player's town¹ |
%husktowns_town_claim_count% | 4 | Number of claims made by the player's town¹ |
%husktowns_town_max_claims% | 6 | Maximum number of claims the player's town can make¹ |
%husktowns_town_max_members% | 5 | Maximum number of members the player's town can have¹ |
%husktowns_town_crop_growth_rate% | 105.0 | Percentage bonus crop growth rate of the player's town¹ |
%husktowns_town_mob_spawner_rate% | 102.5 | Percentage bonus mob spawner rate of the player's town¹ |
%husktowns_town_money% | 1230.32 | Balance of the player's town¹ |
%husktowns_town_money_formatted% | 1k | Balance of the player's town, in short-number format¹ |
%husktowns_town_level_up_cost% | 1500.00 | Cost for the player's town's next level up¹ |
%husktowns_town_level% | 1 | Current level of the player's town¹ |
%husktowns_town_max_level% | 20 | Maximum town level |
%husktowns_current_location_town% | Tomoeda | Name of the town who owns the claim the player is in² |
%husktowns_current_location_town_color% | #aaaaaa | Color of the town who owns the claim the player is in⁵ |
%husktowns_current_location_can_build% | No | If the player can build in the claim they are in³ |
%husktowns_current_location_can_interact% | Yes | If the player can interact in the claim they are in³ |
%husktowns_current_location_can_open_containers% | No | If the player can open containers in the claim they are in³ |
%husktowns_current_location_claim_type% | Plot | The type of claim they are in (Claim, Plot, Farm)³ |
%husktowns_current_location_plot_members% | Sakura32, Toya567 | If this is a plot, the name of members of the plot⁴ |
%husktowns_current_location_plot_managers% | Sakura32 | If this is a plot, the name of managers of the plot⁴ |
%husktowns_current_location_town_money% | 1130.50 | Balance of the town who owns the claim the player is in³ |
%husktowns_current_location_town_money_formatted% | 1k | Same as the above, formatted in short format³ |
%husktowns_current_location_town_level% | 3 | Level of the town who owns the claim the player is in³ |
%husktowns_current_location_town_level_up_cost% | 2400.00 | Cost of the town who owns the claim the player is in to level up³ |
%husktowns_current_location_town_max_claims% | 15 | Maximum number of claims of the town the player is in can make³ |
%husktowns_current_location_town_max_members% | 20 | Maximum number of members the town the player is in can have³ |
%husktowns_current_location_town_crop_growth_rate% | 105.0 | Percentage bonus crop growth rate of the town the player is in³ |
%husktowns_current_location_town_mob_spawner_rate% | 102.5 | Percentage bonus mob spawner rate of the town the player is in³ |
¹ — Or, Not in town if the player is not in a town
² — Or, Wilderness if they are not standing in a claim
³ — Or, Not in claim if they are not standing in a claim
⁴ — Displays Not in claim if they are not standing in a claim and Not a plot if they are not in a plot
⁵ — Returns a gray color for wilderness (if they are not standing in a claim)
These placeholders return the name of the town dependent on their position in the list of towns, sorted by their respective property (where 1 is the highest ranked town). Useful for making in-game leaderboards to promote competition among towns!
%husktowns_town_leaderboard_members_{index}% — Most members%husktowns_town_leaderboard_claims_{index}% — Most claims%husktowns_town_leaderboard_money_{index}% — Highest balance%husktowns_town_leaderboard_level_{index}% — Highest levelYou can also get the value of each town at each index through this format: %husktowns_town_leaderboard_{leaderboard}_{index}_{type}%.
{leaderboard} is one of members, claims, money, or level{index} is the index on the leaderboard (e.g. 10 to get the 10th entry on the leaderboard).{type} is the value type to get for the town at {index} on the leaderboard; one of mayor, members, member_count, claim_count, max_claims, max_members, crop_growth_rate, mob_spawner_rate, money, money_formatted, level_up_cost, level, or max_level.Example: %husktowns_town_leaderboard_money_1_money% to get how much money have the #1 town on money leaderboard (useful to set leaderboard information in holograms).
HuskTowns has optional support for integrating with Dynmap, Pl3xMap or BlueMap to display town claims on your server's web map.
If enabled, HuskTowns will add a layer to your map highlighting chunks that are claimed by the different towns on your server! This is great for visualising where your communities are being built across your server, and to help players plan their next journey.
plugins/HuskTowns/config.ymlweb_map_hook section under generalenabled is set to true and configure the marker set name to your liking