API Clan sync_kingdom_colors

gm.clan.sync_kingdom_colors

Endpoint: gm.clan.sync_kingdom_colors

Syntax

gm.clan.sync_kingdom_colors <clan>

Parameters

Parameter	Type	Required	Description
clan	string	Yes	Clan identifier (StringId or partial name match). Must be a kingdom member and NOT the ruling clan

Named Arguments

This command supports named argument notation, allowing you to specify the clan using the format argName:value (with a colon and no spaces).

Examples:

# Using named arguments
gm.clan.sync_kingdom_colors clan:clan_empire_south_1

# Using positional argument
gm.clan.sync_kingdom_colors clan_empire_south_1

Description

Syncs an individual clan's banner colors back to match the kingdom's colors. This is useful when a single clan's banner was edited and you want to restore it to the kingdom colors without affecting other clans.

WARNING: This will overwrite the specified clan's banner colors with the kingdom colors.

Restrictions:

• The clan must be a member of a kingdom (clanless/independent clans cannot be synced)
• The clan must NOT be the ruling clan (the ruling clan defines the kingdom colors -- use gm.kingdom.sync_vassal_banners to propagate the ruling clan's banner to all vassals instead)

The command updates the clan's banner primary (background) color and icon colors to match the kingdom's PrimaryBannerColor and SecondaryBannerColor, then invalidates cached visuals and marks party visuals as dirty for immediate update.

Examples

Sync a Specific Clan

gm.clan.sync_kingdom_colors clan_empire_south_1

Output:

Synced banner colors for clan 'Mestricaros' to kingdom 'Western Empire' colors.

Using Named Arguments

gm.clan.sync_kingdom_colors clan:sturgia

Error: Ruling Clan

gm.clan.sync_kingdom_colors comnos

Output:

Error: Cannot sync kingdom colors for the ruling clan. The ruling clan defines the kingdom colors. Use gm.kingdom.sync_vassal_banners to propagate the ruling clan's banner to all vassals instead.

Usage Tips

Find Clans: Use query commands to find the exact clan identifier:

gm.query.clan empire
gm.query.clan --kingdom vlandia

After Editing a Vassal Banner: If you edited a vassal clan's banner with gm.clan.edit_banner and want to revert it back to match the kingdom colors, use this command.

Bulk Sync: If you want to sync ALL vassal clans at once, use gm.kingdom.sync_vassal_banners instead.

Clan names with spaces: Use single quotes for multi-word clan names:

gm.clan.sync_kingdom_colors 'dey meroc'

Related Commands

• gm.kingdom.sync_vassal_banners - Sync all vassal banners to kingdom colors
• gm.clan.edit_banner - Edit a clan's banner design
• gm.kingdom.edit_banner - Open banner editor for kingdom's ruling clan

Notes

Kingdom Membership Required: The clan must be a member of a kingdom. Independent clans or clans without a kingdom affiliation will return an error.

Ruling Clan Excluded: The ruling clan cannot use this command because the ruling clan's banner defines the kingdom colors. To update kingdom colors, edit the ruling clan's banner directly with gm.clan.edit_banner or gm.kingdom.edit_banner.

Visual Updates: Banner color changes take effect immediately and persist through save/load cycles.

Color Scope: Only banner background (primary) and icon colors are synced. Banner sigil designs and icon shapes are not modified.

Last Updated: 2026-02-10

BLGM Version: 1.3.14.3 Bannerlord Version: e1.3.1