Skip to content

API Clan edit_banner

SolWayward edited this page Feb 11, 2026 · 3 revisions

gm.clan.edit_banner

Endpoint: gm.clan.edit_banner

Syntax

gm.clan.edit_banner <clan> [removeExtraIcons:false]

Parameters

Parameter Type Required Description
clan string Yes Clan identifier (StringId or partial name match). If the clan is a ruler of a kingdom, then the kingdom banner and colors are updated
removeExtraIcons bool No When true, removes all icons except the last one (main icon), centers it, and resets rotation. Defaults to false. If cancelled, the original multi-icon banner is fully restored.

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.edit_banner clan:'dey meroc'

# Using positional argument
gm.clan.edit_banner player

# Strip to single icon before editing
gm.clan.edit_banner 'dey Meroc' removeExtraIcons:true
gm.clan.edit_banner clan:sturgia removeExtraIcons:true

Description

Opens the native Bannerlord banner editor for the specified clan, allowing you to customize the clan's banner design. If the clan is the ruling clan of a kingdom, then the kingdom banner will be updated which will update the banner colors of vassal clans that are members of the kingdom. Vassal member clan banners can edited after updating the kingdom banner to diverge their banner colors from the kingdom colors. Clothing / Armor colors will always match the kingdom colors instead of the clan colors if the clan is a member of a kingdom, but shields will retain the clan colors over the kingdom colors.

Remove Extra Icons: Many banners in Bannerlord have multiple layered icons. The banner editor only allows editing one icon at a time, and the primary (main) icon is often the last layer, hidden behind other decorative layers. Using removeExtraIcons:true strips all icons except the main icon, centers it, and resets its rotation to 0. This allows you to clearly see and edit the primary icon. If you cancel the editor, the original multi-icon banner is fully restored. This also works on single-icon banners to reset a rotated or off-center icon.

Kingdom Banner Effects: When you edit the banner for a clan that rules a kingdom, the changes will also update the kingdom's banner. This means all vassal clans that are members of that kingdom will reflect the new banner design, as kingdom banners are inherited from the ruling clan.

Important: The banner editor must be enabled in the campaign for this command to work. The editor provides access to all available banner icons, colors, and design elements.

Examples

Edit Player Clan Banner

# Open banner editor for player's clan
gm.clan.edit_banner player

Output:

Opened banner editor for clan '{Player Clan Name}' (ID: {clan_id})

Edit Specific Clan Banner

# Edit banner for Meroc clan
gm.clan.edit_banner Meroc

# Edit banner for dey Meroc clan using single quotes for multi-word name
gm.clan.edit_banner 'dey Meroc'

Edit Banner with Icon Stripping

# Strip multi-icon banner to single icon before editing
gm.clan.edit_banner 'dey Meroc' removeExtraIcons:true

# Reset rotation on a single-icon banner using named argument
gm.clan.edit_banner clan:sturgia removeExtraIcons:true

Output:

Opened banner editor for clan 'dey Meroc' (ID: clan_dey_meroc) (stripped to single icon)

Usage Tips

Clan names or clanIds can be used.

If using clan names with spaces, use single quotes 'dey Rothad' Alternatively, you can just use rothad without single quotes omitting the dey

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

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

Ruling Clan Effects: Remember that changing a ruling clan's banner affects the entire kingdom:

  • The kingdom banner is updated to match the ruling clan's banner
  • All vassal clans display this banner as their kingdom affiliation
  • The banner appears on kingdom troops, settlements, and diplomatic screens

Named Arguments: Use named notation for clarity:

gm.clan.edit_banner clan:sturgia

Icon Stripping: Use removeExtraIcons:true when:

  • The banner has multiple layered icons and you want to edit just the main icon
  • The main icon is rotated or off-center and you want to reset it
  • You want a cleaner starting point for redesigning the banner
  • If you cancel, the original banner is fully restored

Related Commands

Notes

Banner Editor Availability: The banner editor must be enabled in the campaign. If it's disabled, the command will return an error message.

Ruling Clan Impact: When you edit the banner for a clan that rules a kingdom:

  • The kingdom's banner is automatically updated
  • All kingdom settlements display the new banner
  • Kingdom troops carry the new banner into battle
  • Vassal clans show the new banner as their kingdom affiliation
  • The change is immediate and persists through save/load cycles

Visual Changes: Banner modifications made through the editor are saved immediately and affect:

  • Clan's visual representation on the map
  • Kingdom's visual representation (if ruling clan)
  • Troop banners in battle
  • Settlement flags and decorations
  • Diplomatic screens and UI elements

Save Persistence: Banner changes persist through save/load cycles and are stored with the clan data.

Last Updated: 2026-02-10

BLGM Version: 1.3.14.3 Bannerlord Version: e1.3.1

Quick Links

🏠 Home | Quick Reference | Syntax Guide


Hero Commands
Clan Commands
Kingdom Commands
Settlement Commands
Item Commands
Troop Commands
Caravan Commands
Bandit Commands
Query Commands

Clone this wiki locally