PlaceholderAPI

Homestead automatically registers its placeholders with PlaceholderAPI. No expansion packs or extra downloads are needed. Once PlaceholderAPI is installed, every Homestead placeholder works immediately.

---

Installation

1. Install PlaceholderAPI
2. Restart the server
3. Placeholders are available immediately under the homestead identifier (e.g. %homestead_region_name%)

Placeholders that resolve against the player's targeted region fall back to the configured default when no region is selected.

---

Placeholders

Region Information

Placeholder	Description
%homestead_region_name%	Name of player's primary (targeted) region
%homestead_region_current%	Name of region the player is currently standing in
%homestead_region_rank%	Global rank of the targeted region
%homestead_region_claimed_chunks%	Number of chunks claimed in the current region
%homestead_region_max_chunks%	Maximum chunks the player can claim
%homestead_region_trusted_members%	Number of trusted members in current region
%homestead_region_max_members%	Maximum members allowed
%homestead_region_subareas%	Number of sub-areas in the targeted region
%homestead_region_max_subareas%	Maximum sub-areas allowed

Economy Information

Placeholder	Description
%homestead_region_bank%	Balance of the player's region bank
%homestead_upkeep_amount%	Amount due for next upkeep payment
%homestead_upkeep_at%	When the next upkeep payment is due
%homestead_tax_amount%	Current tax amount for the player in the region
%homestead_tax_at%	When the next tax payment is due

War Information

Placeholder	Description
%homestead_war_name%	Name of active war
%homestead_war_prize%	Prize amount for winning the war

---

Default Values

Configure fallback values for when a placeholder resolves to null (no region selected, feature disabled, etc.):

# In config.yml
placeholderapi:
  default:
    region_bank: "None"
    region_name: "None"
    region_rank: "None"
    region_claimed_chunks: "0"
    region_max_chunks: "0"
    region_trusted_members: "0"
    region_max_members: "0"
    region_subareas: "0"
    region_max_subareas: "0"
    region_current: "&2Wilderness"
    upkeep_amount: "0,00"
    upkeep_at: "Never"
    tax_amount: "$0,00"
    tax_at: "Never"
    war_name: "None"
    war_prize: "0,00"

Then run /hsadmin reload.