Brigades are the type of entity that represents the units of the game. The general rules of entity modding apply to brigades; the contents of the entity defined can have the following tags:
| Attribute Name | Required? | Type | Description |
|---|---|---|---|
| constxpdefeat | No (default 0) | Number | How much experience is divided between attackers per unit in the brigade when defeated |
| consthitpoints | No (default 0) | Number | Hit points per unit |
| constviewrange | No (default 0) | Number | View range |
| constmeleedamageperday | No (default 0) | Number | Amount of melee damage it can do |
| constmissiledamagerate | No (default 0) | Number | Amount of missile damage it can do |
| constmissilerange | No (default 0) | Number | Missile range |
| constmissilefiretime | No (default 0) | Number | The amount of time the firing animation should take |
| constmissiledefence | No (default 0) | Number | Percentage defence against missile damage e.g. damage = missiledamage * (1 - missiledefence) |
| constchargestrength | No (default 0) | Number | Charge strength |
| constchargeblock | No (default 0) | Number | Charge block |
| constambush | No (default 0) | Number | Skill at going undetected by enemies |
| constrecon | No (default 0) | Number | Ability to detect ambushing enemies |
| constcargocapacityperunit | No (default 0) | Number | How much food each unit can carry |
| constrecruitdays | No (default 0) | Number | Number of days to recruit/replace the whole brigade |
| constrecruitsperunit | No (default 0) | Number | Number recruits needed from their home city to add a man to the unit |
| constwoodperunit | No (default 0) | Number | Wood consumed to build this |
| constcostperday | No (default 0) | Number | Gold cost per week |
| constwalkspeed | No (default 0) | Number | How quickly it moves across the map normally |
| construnspeed | No (default 0) | Number | How quickly it moves across the map when charging |
| movestyle | No (default "unit") | Text | Can be ship/vehicle/cavalry/cart/unit, which controls some of the units pathfinding behaviour |
| namestyle | No (default "numberedcity") | Text | Can be numberedcity/numberedfaction/brigadetype, which affects whether the brigades name appears as "I Archers of Mediolanum", "I Archers of the Insubres" or "Archers" |
| permadeath | No (default false) | true/false | Can be set to true to stop units reappearing and rerecruiting at their home city |
| watermovement | No (default "none") | Text | If set to open, the unit travels on sea rather than land |
| carrytoops | No (default false) | true/false | If true, it is possible for a brigade to enter this one as a transport ship |
| buildcaptorfaction | No (default false) | true/false | If true, brigade ignores a city's native faction when detecting if a faction can build it |
| buildattribute | No (no defaults) | Text | Any attribute name that needs to be detected as true in the captor city in order for the brigade to be built; one per tag, multiple tags definable |
| earnxp | No (default true) | true/false | Can be set to false to make this brigade unable to receive xp |
| article | Yes | Text | The name of the base for strings regarding the brigade (brigade requires a ::TYPE and ::TOOLTIP substring) |
| portrait | Yes | Atlas Ref | Atlas reference for the portrait shown when unit is selected. One per tag, multiple tags can be defined. If there's more than one, a random one from the list will be chosen for each brigade of this type built. |
| tagsprite | Yes | Atlas Ref | Atlas reference for the tag hovering over the unit |
| buildfactiongroup | No (no defaults) | Text | Faction group able to recruit this brigade. One per tag, multiple tags can be defined. |
| mercfactiongroup | No (no defaults) | Text | Faction group able to hire this as a mercenary. One per tag, multiple tags can be defined. Can have a weight attribute saying how likely it is to appear in the mercenary list. |
| containerorder | No (default 0) | Number | Brigade's placement in a city or camp's list of contained brigades (lower numbers to appear earlier, higher to appear later) |
| buildbutton | Yes | Atlas Ref | Atlas reference for the button seen in the build menu |
| buildmenuorder | No (default 0) | Number | Placement in the build menu (lower numbers to appear earlier, higher to appear later) |
| soundstyle | Yes | Text | Style of sounds it makes |
| stanceclass | Yes | Text | The class stance. Each stance has a list of classes that it appears for. |
| defaultstance | No (default skirmish stance) | Entity Ref | Class and type of the default stance, defined as attributes of the tag rather than as contents |
| basenumunits | No (default 10) | Number | Number of units in a fully-recruited brigade brigade |
| miniatureent | Yes | Entity Ref | Name of the mesh used for the miniature |
| miniatureradius | Yes | Number | Size of the miniature |
| unit | Yes | Mixed | Name of the unit types used in the brigade, more than one can be defined to make the brigade's units look more varied |
An example brigade file is posted here:
<entity> <type>etruscanAxemen</type> <class>brigade</class> <!-- stats --> <constxpdefeat>12.5</constxpdefeat> <!-- xp award per unit killed (divided amongst its attackers when the unit routs or is completely killed) --> <consthitpoints>75</consthitpoints> <!-- hitpoints per unit --> <constviewrange>16</constviewrange> <!-- view distance in km (is doubled with full initiative) --> <constmeleedamageperday>75</constmeleedamageperday> <!-- melee damage per day --> <constmissiledamagerate>30</constmissiledamagerate> <constmissilerange>4</constmissilerange> <!-- melee damage per day --> <constmissilefiretime>0.093</constmissilefiretime> <!-- THIS IS THE CORRECT FIRE RATE FOR THE ANIMATION --> <constmissiledefence>0.2</constmissiledefence> <!-- percentage defence against missile damage e.g. damage = missiledamage * (1 - missiledefence) --> <constchargestrength>50</constchargestrength> <constchargeblock>10</constchargeblock> <constambush>25</constambush> <constrecon>0</constrecon> <constcargocapacityperunit>1</constcargocapacityperunit> <!-- tons of cargo carried per unit (for food or ore) --> <constrecruitdays>4</constrecruitdays> <!-- number of days to recruit/replace the whole brigade --> <constrecruitsperunit>1.5</constrecruitsperunit> <!-- number recruits needed from their home city to add a man to the unit --> <constcostperday>20</constcostperday> <!-- cost per day while in a city/fort --> <constwalkspeed>5</constwalkspeed> <construnspeed>8</construnspeed> <!--article>Spearmen</article--> <article>Units::Axemen</article> <portrait atlas="objportraits" sprite="etruscanaxemen"/> <tagsprite atlas="buffs" sprite="unittag_axeman"/> <mercfactiongroup weight="10">etruscan</mercfactiongroup> <mercfactiongroup weight="10">latin</mercfactiongroup> <mercfactiongroup weight="10">sabellic</mercfactiongroup> <mercfactiongroup weight="4">illyric</mercfactiongroup> <mercfactiongroup weight="5">greek</mercfactiongroup> <mercfactiongroup weight="7">gaul</mercfactiongroup> <containerorder>20</containerorder> <buildbutton atlas="buttons" sprite="buildetruscanaxemen"/> <buildmenuorder>20</buildmenuorder> <buildfactiongroup>etruscan</buildfactiongroup> <soundstyle>infantry</soundstyle> <!-- formation/stances --> <stanceclass>javelineer</stanceclass> <defaultstance class="brigadestance" type="skirmish"/> <!-- size of the brigade --> <basenumunits>20</basenumunits> <miniatureent class="objectmesh" type="mesh_mini_etruscanAxemen"/> <miniatureradius>1.0</miniatureradius> <!-- brigade unit composition --> <!-- format || unitclass, min, max, percentage --> <unit type="unit_etruscan_axeman">0 0 100</unit> </entity>
Default Brigade Types[ | ]
- captives
- genericGeneral
- raidingShip
- colonistBrigade
- etruscanArchers
- etruscanAxemen
- etruscanGeneral
- etruscanHeavyCavalry
- etruscanHeavyHoplite
- etruscanHeavySwordsmen
- etruscanLightCavalry
- etruscanLightHoplite
- etruscanLightSwordsmen
- etruscanSpearmen
- foodcaravanbrigade
- gallicArchers
- gallicLightCavalry
- gallicGeneral
- gallicJavelineers
- gallicLightSwordsmen
- gallicNakedSwordsmen
- gallicNobleCavalry
- gallicNobleSwordsmen
- gallicSlingers
- gallicSpearmen
- greekHeavyHoplite
- greekHypaspist
- greekLightHoplite
- greekMountedJavelineers
- greekPeltasts
- greekPhalangites
- greekPsiloi
- greekSpearmen
- hostageBrigade
- illyricHeavyHoplite
- illyricHeavySwordsmen
- illyricLightHoplite
- illyricLightSwordsmen
- illyricMountedJavelineers
- illyricPeltasts
- illyricSkirmishers
- illyricSlingers
- illyricSpearmen
- latinEquites
- latinGeneral
- latinHastati
- latinHeavyHoplite
- latinLeves
- latinLightHoplite
- latinPrincipes
- latinSpearmen
- latinTriarii
- latinVelites
- lesserTrireme
- nonromanwarshipbrigade
- raiderArchers
- raiderLightCavalry
- raiderGeneral
- raiderHoplites
- raiderJavelineers
- raiderSkirmishers
- raiderSlingers
- romanwarshipbrigade
- sabellicHeavyHoplite
- sabellicHeavySwordsmen
- sabellicJavelineers
- sabellicLightHoplite
- sabellicLightSwordsmen
- sabellicNobleCavalry
- sabellicSpearmen
- sabellicVelites
- scorpionbrigade
- seacaravanbrigade
- slavebrigade
- woodcaravanbrigade
- workerBrigade