> For the complete documentation index, see [llms.txt](https://arcadia-9.gitbook.io/towns-and-nations/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://arcadia-9.gitbook.io/towns-and-nations/server-owners/placeholders-placeholder-api.md).

# Placeholders (Placeholder API)

Towns and Nations provides placeholders for placeholder API. No prerequisites needs to be installed. The syntax `{some text}` in certain placeholder requires more information inside the placeholder (the curly braces needs to be kept).

### Player

```yaml
tan_player_balance : balance of the player.
tan_chat_mode : the chat mode of the player
tan_chat_mode_{player name} : the chat mode of a selected player
```

### Territories

#### Town

```yaml
tan_player_town_name : The name of the player's town.
tan_player_{player name}_town_name :  The name of a selected player's town.
tan_player_town_colored_name : The colored name of the player's town.
tan_player_{player name}_town_colored_name :  The colored name of the selected player's town.

tan_player_town_tag : The town tag of the player
tan_player_{player name}_town_tag : The town tag of a selected player
tan_player_colored_town_tag : The colored town tag of the player

tan_player_town_balance: balance of the player's town.

tan_player_town_rank_name: name of the player's rank.
tan_player_town_rank_colored_name: colored name of the player's rank.

tan_player_town_resident_quantity : number of resident in the player's town.
tan_player_town_chunk_actual_quantity: number of claimed chunk in the player's town.
tan_player_town_chunk_max_quantity: maximum number of claimed chunk in the player's town.
tan_player_town_chunk_remaining_quantity: Number of additional chunks that the player's town can claim.
```

### Region

```yml
tan_player_region_name: name of the player's region.
tan_player_{player name}_region_name : name of a selected player's region.

tan_player_region_balance : balance of the region of the player.

tan_player_region_resident_quantity: number of players in the player's region.
tan_player_region_chunk_actual_quantity: number of claimed chunk in the player's region.

```

### Nation

```yaml
tan_player_nation_name: Name of the player's nation
tan_player_{player name}_nation_name: Name of the nation of a specific player
player_nation_balance: Balance of the nation of the player.
player_nation_chunk_actual_quantity: number of claimed chunk in the player's nation
player_nation_rank_colored_name: colored name of the player's rank.
player_nation_rank_name: name of the player's rank.
```

### Location

Location placeholders use the player actual position as parameter

```yaml
tan_player_location_property_exist: TRUE/FALSE
tan_player_location_property_name: "No property found" or the property name
tan_player_location_property_is_owner: "No property found" or TRUE/FALSE
tan_player_location_chunk_type_name: "Wilderness / Landmark / Town / Region"
tan_player_location_chunk_name: "Wilderness / landmark name / Territory name"
tan_player_location_pvp_enabled: "TRUE/FALSE"
```

### Conditions

Conditional placeholder all returns TRUE or FALSE. Used for simple logic

```yaml
tan_territory_with_name_{town name}_exist: TRUE/FALSE
tan_territory_with_id_{ID}_exist: TRUE/FALSE
tan_player_{username}_have_town: TRUE/FALSE
tan_player_{username}_is_town_overlord: TRUE/FALSE

```

### Others

```yaml
tan_player_bigger_overlord_name : name of the bigger overlord a player has

tan_territory_with_name_{town name}_leader_name : name of leader of the territory
tan_territory_with_id_{ID}_leader_name : name of leader of the territory
tan_server_get_first_territory_id_with_name_{name of the territory} : the ID of the territory
```

{% hint style="info" %}
Ask on the official [discord](https://discord.com/invite/DDg7JkR2hc) for more placeholders
{% endhint %}