Placeholders

HuskTowns provides placeholders through the PlaceholderAPI (PAPI) plugin via a special expansion.

Setup

  1. Install PAPI and HuskTowns (version 1.3.1+) on your server
  2. Run /papi ecloud download HuskTowns to download the HuskTowns expansion
    • If that doesn't work, download HuskTowns-Expansion.jar from the PlaceholderAPI eCloud and manually place this in your expansions directory under /plugins/PlaceholderAPI/expansions
  3. Type /papi reload or restart the server
  4. You will now be able to make use of the supported placeholders (see below)
    • You can test these in-game with the /papi parse <player> <placeholder> command

Placeholders

The followign table contains the available placeholders. You can customise the replacement messages in the plugin locales file. If you wish to customise the Yes/No messages, please edit your PlaceholderAPI config as those are sourced from there.

PlaceholderReplacementNotes
%husktowns_town_name%WatersideName of town the player is in¹
%husktowns_town_role%CitizenName of the role the player has in their town¹
%husktowns_town_mayor%William278Name of the player's town mayor¹
%husktowns_town_color%#ff1200Color of the player's town¹
%husktowns_town_members%Mark12, William278, MeetTheProList of members of the player's town¹
%husktowns_town_member_count%3Number of members of the player's town¹
%husktowns_town_claim_count%4Number of claims made by the player's town¹
%husktowns_town_max_claims%6Maximum number of claims the player's town can make¹
%husktowns_town_max_members%5Maximum number of members the player's town can have¹
%husktowns_town_money%1230.32Balance of the player's town¹
%husktowns_town_level_up_cost%1500.00Cost for the player's town's next level up¹
%husktowns_town_level%1Current level of the player's town¹
%husktowns_town_max_level%20Maximum town level
%husktowns_current_location_town%TomoedaName of the town who owns the claim the player is in²
%husktowns_current_location_can_build%NoIf the player can build in the claim they are in³
%husktowns_current_location_can_interact%YesIf the player can interact in the claim they are in³
%husktowns_current_location_can_open_containers%NoIf the player can open containers in the claim they are in³
%husktowns_current_location_claim_type%PlotThe type of claim they are in (Claim, Plot, Farm
%husktowns_current_location_plot_members%Sakura32, Toya567If this is a plot, the name of members of the plot⁴
%husktowns_current_location_plot_managers%Sakura32If this is a plot, the name of managers of the plot⁴
%husktowns_current_location_town_money%1130.50Balance of the town who owns the claim the player is in³
%husktowns_current_location_town_level%3Level of the town who owns the claim the player is in³
%husktowns_current_location_town_level_up_cost%2400.00Cost of the town who owns the claim the player is in to level up³
%husktowns_current_location_town_max_claims%15Maximum number of claims of the town the player is in can make³
%husktowns_current_location_town_max_members%20Maximum number of members the town the player is in can have³

¹ — 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