-
Notifications
You must be signed in to change notification settings - Fork 0
API Clan generate_clans
Endpoint: gm.clan.generate_clans
gm.clan.generate_clans <count> [cultures] [kingdom] [createParties] [companionCount]
| Parameter | Type | Required | Description |
|---|---|---|---|
count |
integer | Yes | Number of clans to generate (1-50) |
cultures |
string | No | Culture filter(s). Use commas to separate multiple cultures (e.g., vlandia,battania). Can also use group keywords: main_cultures (default), bandit_cultures, all_cultures |
kingdom |
string | No | Kingdom identifier for all clans to join. If not specified or 'null', clans are independent |
createParties |
boolean | No | Whether to create parties for clan leaders (default: true) |
companionCount |
integer | No | Number of companions per clan leader (0-10, default: 2) |
This command supports named argument notation, allowing you to specify optional parameters in any order using the format argName:value (with a colon and no spaces).
Benefits:
- Specify optional parameters without providing all preceding parameters
- Arguments can be in any order when using named notation
- Mix positional and named arguments
Examples:
# Using named arguments
gm.clan.generate_clans count:10 cultures:vlandia,battania kingdom:vlandia
# Specify only what you need
gm.clan.generate_clans 5 kingdom:sturgia companions:5
# Mix positional and named arguments
gm.clan.generate_clans 10 vlandia,battania parties:true companions:3Generates multiple clans with random names from culture lists. This command is ideal for quickly populating kingdoms with new noble houses. Each generated clan receives:
- Random Name: Culture-appropriate clan name
- Auto-Generated Leader: New hero with good stats and equipment
- Culture: Matches the selected culture pool
- Tier: Starts at tier 3 with initial renown and gold
- Party: Optional party for the leader with troops and companions
- Status: Fully functional and ready for recruitment
Generated clans act like normal NPC clans and can be recruited by kingdoms (including the player's), expand their forces, and participate in wars.
Kingdom Assignment: If no kingdom is specified, clans are created as independent and can be recruited by any kingdom. If a kingdom is specified, all generated clans join that kingdom immediately.
# Generate 5 independent clans from main cultures
gm.clan.generate_clans 5Output:
Generated 5 clan(s) as independent (with parties) and 2 companions each:
[Detailed clan information]
# Generate 10 Vlandian and Battanian clans for Vlandia kingdom
gm.clan.generate_clans 10 vlandia,battania vlandiaOutput:
Generated 10 clan(s) and joined Vlandia (with parties) and 2 companions each
# Generate 3 Imperial clans
gm.clan.generate_clans 3 empire
# Generate 5 clans from multiple cultures
gm.clan.generate_clans 5 vlandia,battania,sturgia
# Generate clans from all main cultures
gm.clan.generate_clans 10 main_cultures# Generate clans without parties (civilian/trading clans)
gm.clan.generate_clans 3 empire vlandia false 0
# Generate war-focused clans with many companions
gm.clan.generate_clans 5 vlandia vlandia true 8
# Using named arguments for clarity
gm.clan.generate_clans count:10 cultures:battania,sturgia kingdom:sturgia companions:5Culture Selection:
# Use predefined groups
gm.clan.generate_clans 10 main_cultures
gm.clan.generate_clans 5 bandit_cultures
gm.clan.generate_clans 20 all_cultures
# Specify individual cultures with commas (no spaces)
gm.clan.generate_clans 10 vlandia
gm.clan.generate_clans 15 empire,aserai
gm.clan.generate_clans 8 vlandia,battania,sturgiaKingdom Assignment:
# Independent clans (can be recruited by any kingdom)
gm.clan.generate_clans 5
gm.clan.generate_clans 5 vlandia null
# Join specific kingdom
gm.clan.generate_clans 10 empire empire_s
gm.clan.generate_clans 5 vlandia,battania vlandiaParty and Companion Configuration:
# Default: parties with 2 companions
gm.clan.generate_clans 5
# No parties (trading/civilian clans)
gm.clan.generate_clans 3 empire null false 0
# War-focused clans with many companions
gm.clan.generate_clans 5 vlandia vlandia true 10Populating Kingdoms:
# Add 10 new noble houses to Vlandia
gm.clan.generate_clans 10 vlandia vlandia
# Create diverse independent clans for recruitment
gm.clan.generate_clans 15 main_cultures
# Create specialized mercenary clans
gm.clan.generate_clans 5 main_cultures null true 8Named Arguments for Complex Setups:
# Skip positional parameters
gm.clan.generate_clans count:10 kingdom:vlandia companions:5
# Specify only what matters
gm.clan.generate_clans 5 cultures:battania parties:falseQuery Available Cultures:
gm.query.culture # List all cultures
gm.query.culture main # List main cultures only
gm.query.culture bandit # List bandit cultures onlyUse gm.clan.generate_clans when you need:
- Multiple clans quickly
- Random culture-appropriate names
- Bulk population of kingdoms
- Quick world expansion
Use gm.clan.create_clan when you want:
- A single clan with custom name
- Specific hero as leader
- More control over individual clan properties
- API-Clan-Overview - All clan commands
- gm.clan.create_clan - Create single clan with custom name
- gm.clan.rename - Rename clans after creation
- gm.clan.set_culture - Change clan culture
- gm.clan.set_tier - Adjust clan tier
- gm.clan.add_gold - Give gold to clans
- gm.clan.set_renown - Set clan renown
- gm.kingdom.add_clan - Add clans to kingdoms
- gm.hero.generate_lords - Generate additional lords for clans
- gm.query.clan - Find generated clans
- gm.query.culture - Query available cultures
Random Generation: Clans are created with:
- Random culture-appropriate names from their culture's name lists
- Auto-generated leaders with good equipment and stats
- Age-appropriate leaders (20-30 years old)
- Culture-specific appearances and equipment
- Initial tier 3 status with appropriate renown and gold
Generated Clan Behavior: These clans act like normal NPC clans. They can:
- Be recruited by any kingdom (player or NPC)
- Expand their forces and recruit lords
- Participate in wars and diplomacy
- Own fiefs and settlements
- Build workshops and caravans
Party Creation: When parties are created, each clan leader gets:
- 10 basic troops matching their culture
- 20000 trade gold for party operations
- The specified number of companions with good equipment
Companions: Companions are generated with:
- Culture-appropriate templates
- Good equipment and stats
- Random appropriate names
- Direct addition to the leader's party
Kingdom Recruitment: Independent clans can be recruited by kingdoms through normal diplomacy. This makes them valuable additions to the world that kingdoms will actively try to recruit.
Culture Matching: Clan names, leader names, and equipment all match the selected culture(s), ensuring appropriate cultural aesthetics.
Custom Names: For custom clan names, use gm.clan.create_clan instead, or use gm.clan.rename after generation.
Last Updated: 2026-02-10
BLGM Version: 1.3.14.3 Bannerlord Version: e1.3.1
🏠 Home | Quick Reference | Syntax Guide
Hero Commands
- gm.hero.abort_pregnancy
- gm.hero.add_gold
- gm.hero.add_hero_to_party
- gm.hero.create_companions
- gm.hero.create_lord
- gm.hero.create_party
- gm.hero.divorce
- gm.hero.edit_appearance
- gm.hero.edit_party
- gm.hero.equip_hero
- gm.hero.export_character
- gm.hero.generate_lords
- gm.hero.give_birth
- gm.hero.heal
- gm.hero.import_character
- gm.hero.impregnate
- gm.hero.imprison
- gm.hero.kill
- gm.hero.list_appearances
- gm.hero.list_characters
- gm.hero.list_developments
- gm.hero.list_traits
- gm.hero.load_appearance
- gm.hero.load_character
- gm.hero.load_development
- gm.hero.load_traits
- gm.hero.marry
- gm.hero.open_inventory
- gm.hero.release
- gm.hero.remove_clan
- gm.hero.rename
- gm.hero.save_appearance
- gm.hero.save_development
- gm.hero.save_traits
- gm.hero.set_age
- gm.hero.set_clan
- gm.hero.set_culture
- gm.hero.set_gold
- gm.hero.set_relation
- gm.hero.start_convrsation
Clan Commands
- gm.clan.add_gold
- gm.clan.add_gold_leader
- gm.clan.add_hero
- gm.clan.add_renown
- gm.clan.create_clan
- gm.clan.create_minor_clan
- gm.clan.destroy
- gm.clan.edit_banner
- gm.clan.equip_heroes
- gm.clan.generate_clans
- gm.clan.give_gold
- gm.clan.rename
- gm.clan.set_culture
- gm.clan.set_gold
- gm.clan.set_leader
- gm.clan.set_renown
- gm.clan.set_tier
- gm.clan.sync_kingdom_colors
Kingdom Commands
- gm.kingdom.add_clan
- gm.kingdom.call_ally_to_war
- gm.kingdom.create_kingdom
- gm.kingdom.declare_alliance
- gm.kingdom.declare_war
- gm.kingdom.destroy
- gm.kingdom.edit_banner
- gm.kingdom.equip_heroes
- gm.kingdom.generate_kingdoms
- gm.kingdom.get_tribute_info
- gm.kingdom.make_peace
- gm.kingdom.pay_tribute
- gm.kingdom.remove_clan
- gm.kingdom.rename
- gm.kingdom.set_ruler
- gm.kingdom.sync_vassal_banners
- gm.kingdom.trade_agreement
Settlement Commands
- gm.settlement.add_militia
- gm.settlement.fill_garrison
- gm.settlement.give_food
- gm.settlement.give_gold
- gm.settlement.rename
- gm.settlement.reset_names
- gm.settlement.set_culture
- gm.settlement.set_hearths
- gm.settlement.set_loyalty
- gm.settlement.set_owner
- gm.settlement.set_owner_clan
- gm.settlement.set_prosperity
- gm.settlement.set_security
- gm.settlement.set_village_bound_settlement
- gm.settlement.set_village_trade_bound_settlement
- gm.settlement.spawn_wanderer
- gm.settlement.upgrade_buildings
Item Commands
- gm.item.add
- gm.item.equip
- gm.item.equip_slot
- gm.item.list_equipped
- gm.item.list_inventory
- gm.item.load_equipment
- gm.item.load_equipment_both
- gm.item.load_equipment_civilian
- gm.item.remove
- gm.item.remove_all
- gm.item.remove_equipped
- gm.item.remove_equipped_modifier
- gm.item.save_equipment
- gm.item.save_equipment_both
- gm.item.save_equipment_civilian
- gm.item.set_equipped_modifier
- gm.item.set_inventory_modifier
- gm.item.transfer
- gm.item.unequip
- gm.item.unequip_all
- gm.item.unequip_slot
Query Commands
- gm.query.character_objects
- gm.query.character_objects_any
- gm.query.character_objects_info
- gm.query.clan
- gm.query.clan_any
- gm.query.clan_info
- gm.query.culture
- gm.query.culture_info
- gm.query.hero
- gm.query.hero_any
- gm.query.hero_info
- gm.query.item
- gm.query.item_any
- gm.query.item_info
- gm.query.kingdom
- gm.query.kingdom_any
- gm.query.kingdom_info
- gm.query.modifier_info
- gm.query.modifiers
- gm.query.settlement
- gm.query.settlement_any
- gm.query.settlement_info
- gm.query.troop
- gm.query.troop_any
- gm.query.troop_info