BlueMap-Towny

BlueMap-Towny

> *BlueMap addon for showing your Towny towns on your beautiful map*

Configuration, placeholders and main features heavily inspired by Dynmap-Towny. Has support for holes in claims and claims outside main town. Does not have support for external plugins hooking into placeholders.

Installation

Put the plugin jar file inside your plugins folder and have both Towny and BlueMap installed. The plugin does not come with any default icons. I recommend just using Dynmap's marker icons

Config

```yml

BlueMap-Towny configuration

https://github.com/Chicken/BlueMap-Towny#config

Seconds between checks for marker updates

update-interval: 30

Display name of the marker set shown in BlueMap UI

marker-set-name: Towns

Label for town markers, %name% is replaced with the town name

town-label: '%name%'

Label for outpost markers, %name% is replaced with the town name, %index% with the outpost number

outpost-label: '%name% Outpost %index%'

Set by /n set mapcolor

dynamic-nation-colors: true

Set by /t set mapcolor

dynamic-town-colors: true

HTML for town popup, placeholders documented in README

popup: '%name% (%nation%)
Mayor %mayor%
Residents %residents%
Bank %bank%'

HTML for War popup(SiegeWar Only), placeholders documented in README

popup-siege: 'Siege: %attacker% vs %defender%

If you want claims with holes in them to show up as fully claimed if only the perimeter is claimed.

This means that the map will LIE about the actual claim status of the area!!!

lie-about-holes: false

For servers with a lot of towns, filter smaller ones out of the map, -1 to disable filter

min-town-blocks: -1 min-residents: -1 style:

Y-level to put area markers at, icons are at spawn positions

y-level: 62

Use y level of town home for areas, fallback to y-level

use-home-y: false

Town border settings

border-color: '#FF0000' border-opacity: 0.8 border-width: 3

Town fill settings

fill-color: '#FF0000' fill-opacity: 0.35

Path to icons on web or a link

Town home

home-icon-enabled: false home-icon: assets/house.png home-icon-anchor-x: 8 home-icon-anchor-y: 8

Nation capital

capital-icon-enabled: false capital-icon: assets/king.png capital-icon-anchor-x: 8 capital-icon-anchor-y: 8

Icon during war

war-icon-enabled: false war-icon: assets/war.png war-icon-anchor-x: 8 war-icon-anchor-y: 8

Icon for ruined towns

ruined-icon-enabled: false ruined-icon: assets/ruined.png ruined-icon-anchor-x: 8 ruined-icon-anchor-y: 8

Icon for outposts

outpost-icon-enabled: false outpost-icon: assets/tower.png outpost-icon-anchor-x: 8 outpost-icon-anchor-y: 8 ```

Label placeholders

`town-label` and `outpost-label` support the following placeholders:

| Placeholder | Content | |-------------|---------------------------------| | `%name%` | Town name | | `%index%` | Outpost number (outpost-label only) |

Popup placeholders

| Placeholder | Content | |--------------------------|------------------------------------------------------------------------| | `%name%` | Town name | | `%mayor%` | Town mayor | | `%residents%` | Town residents | | `%assistants%` | Town assistants | | `%residentdisplaynames%` | Town residents but display names | | `%residentcount%` | Number of town residents | | `%founded%` | Town founding date | | `%board%` | Town board text | | `%trusted%` | Town trusted residents | | `%tax%` | Town tax | | `%bank%` | Town bank balance | | `%nation%` | Nation of the town | | `%nationstatus%` | Capital/Member of ... | | `%public%` | Town publicity status | | `%peaceful%` | Is the town peaceful | | `%flags%` | Flags of the town (pvp, mobs...) | | `%war%` | Has active war (Works for EventWar/FlagWar) | | `%town_culture%` | Culture of town, see https://github.com/TownyAdvanced/TownyCultures | | `%town_resources%` | Resources of town, see https://github.com/TownyAdvanced/TownyResources |

SiegeWar Placeholders

| Placeholder | Content | |----------------------------|---------------------------------------------| | `%attacker%` | Attacking town/nation in war | | `%defender%` | Defending town/nation in war | | `%siege_type%` | Type of Siege (Conquest, Revolt etc) | | `%sessions_completed%` | Battle Sessions completed | | `%session_total%` | Total amount of Battle Sessions | | `%war_chest%` | War Chest (If economy is enabled for Towny) | | `%banner_control%` | the ones controlling the banner | | `%siege_status%` | Siege status | | `%siege_balance%` | Siege balance | | `%battle_points_attacker%` | Battle points on the attacker's side | | `%battle_points_defender%` | Battle points on the defender's side | | `%battle_time_left%` | Time left in the Battle Session |