Heraldy

Heraldry

Cities and alliances can design their own coat of arms. The arms are stored on the city or alliance itself, so they follow it everywhere: the interface, the world map, and the flags your soldiers plant in a war.

Designing arms

Open the main window with Ctrl+Shift+U (see GUI). Go to the City tab and press the flag button. For an alliance, open Alliance and press the flag button in its card. Either one opens the coat of arms editor.

The editor has three parts:

• Preview: the finished arms, their layer string, and the Apply / Clear buttons.
• Layers: the stack so far, bottom layer first, with a button to remove the top one.
• Add a layer: a pattern and a colour picker, a preview of that layer alone, and a preview of the result.

Nothing is sent to the server until you press Apply, so you can try things freely.

Rules

• The bottom layer must be a solid fill (the color pattern). Without it the uncovered parts of the banner stay transparent.
• A solid fill can only be the bottom layer. Higher up it would paint over everything below it.
• Up to 6 layers in total (EMBLEM_MAX_LAYERS), background included.
• 32 patterns in 11 colours are offered by default.

The layer string

An emblem is stored as one string: layers separated by ;, bottom one first.

color_red;cross_white;lion_left_yellow

Each layer is the name of a texture file, so you can type the same string by hand:

/city set emblem color_red;cross_white
/city set emblem                          - clears the arms
/alliance set emblem color_blue;lion_left_yellow

The command reports the first bad layer instead of silently dropping it. So a typo tells you which pattern it did not recognise.

Where the arms appear

Place	Shown as
City tab / Alliance tab	Small icon in the card
World city list, world alliance list	48px icon at the left of each row
Conflicts list	Arms of both sides, in the order the names are read
World map	In the tooltip when you point at a plot
City entry banner	In the banner shown when you walk into a city
Capture flags	The banner flies the attacking city's arms during a war

Cities without arms get an empty plate in the lists, so rows stay aligned.

Permissions

Permission	Grants
CITY_SET_EMBLEM	Change the city's arms (mayors have it by default)
ALLIANCE_SET_EMBLEM	Change the alliance's arms (the alliance leader)

CITY_SET_ALL also covers the city's arms. See Permissions and Ranks.

Server configuration

Setting	Default	Description
EMBLEM_MAX_LAYERS	6	Layers per emblem, background included
EMBLEM_AVAILABLE_PATTERNS	(empty)	Empty offers the built-in set; a non-empty list replaces it
EMBLEM_AVAILABLE_COLORS	(empty)	Same rule for colours

The mod ships more pattern textures than it offers by default. A server can widen the choice by listing extra names in EMBLEM_AVAILABLE_PATTERNS. Names are the texture file names in assets/claims/textures/emblem/pattern, without the _<colour> suffix.

Each unique combination of layers takes one entry in the texture atlas. That is why the layer count is kept low.

Credits

The pattern textures come from HeraldryBanners by Craluminum2413 and are used under the MIT license. The full license text ships with the mod in THIRD_PARTY_NOTICES.md.

See also

• Cities
• Alliances
• War and Conflicts
• GUI