Subscribe to download
XModBase 2.0 for War of the Chosen (beta)

This has not been extensively tested. Please treat it as beta quality, and report any bugs you find.

XModBase (XMB) is a library for mod authors, designed to make it easier to create interesting and unique perks. It provides a collection of effects and conditions which can be combined to create a huge variety of different perks. It takes care of annoying details like filling out all the boring-but-necessary fields of X2AbilityTemplate, and provides support for localization tags so you can change your abilities' values in one place and have their descriptions update automatically.


If you're a player, you don't need to worry about XModBase. It's safe to install multiple mods that use XModBase, even if they use different versions.


There are two ways of using XMB: one that's easy, and one that's better.


Easy installation will make it possible to build and run your mod using XModBase. However, if you publish your mod, your users will need to install XModBase separately.

1. Copy the XModBase mod files to "C:\Program Files (x86)\Steam\SteamApps\common\XCOM 2\XComGame\Mods\XModBase".

2. Copy all the XMB*.uc files from XModBase\Src\XModBase\Classes to your own mod's Classes directory.

3. Add the following lines to your mod's XComEngine.ini. Note that steam adds invisible characters to the end of the line which you must remove if you copy+paste these!

[UnrealEd.EditorEngine]
+ModEditPackages=LW_Tuple
+ModEditPackages=XModBase_Interfaces
+ModEditPackages=XModBase_Core_2_0_2


Complete installation will include the XModBase libraries in your mod, so you can publish it without your users needing to install XModBase. Your mod will still be compatible with other mods using XModBase, even mods which have a different version. Users will automatically get the latest version of XModBase from any installed mod.

1. Copy all the XMB*.uc files from XModBase\Src\XModBase\Classes to your own mod's Classes directory.

2. Create new folders under your mod's Src folder so it looks like this:



3. Now, for each of those "Classes" folders, right-click and choose "Add > Existing Item...", then add all of the *.uc files from the corresponding directory in XModBase. You should end up with a Src directory like this:



4. Add the following lines to your mod's XComEngine.ini. Note that steam adds invisible characters to the end of the line which you must remove if you copy+paste these!

[Engine.ScriptPackages]
+NonNativePackages=LW_Tuple
+NonNativePackages=XModBase_Interfaces
+NonNativePackages=XModBase_Core_2_0_2

[UnrealEd.EditorEngine]
+ModEditPackages=LW_Tuple
+ModEditPackages=XModBase_Interfaces
+ModEditPackages=XModBase_Core_2_0_2


First, look in XModBase\Src\XModBase\Classes for Examples.uc. It contains several example abilities built using XModBase classes.

Your ability sets should extend XMBAbility, rather than X2Ability. XMBAbility adds several utility functions and properties to reduce the amount of boilerplate needed when to make a new ability.

The most versatile class in XModBase is XMBEffect_ConditionalBonus. It can provide passive bonuses to attack hit chances, damage, and/or defense. The bonuses can be conditional on hit type, weapon tech level, or any X2Condition - and XModBase includes a number of conditions for common checks. So if you want you can apply a damage bonus on critical hits with the primary weapon, or an increased hit chance against targets at higher elevation, you can.

XModBase provides additional effects that are either commonly useful or hard to do. Here's a list of some of the available effects:

XMBEffect_AbilityCostRefund - Passively refunds ability costs based on conditions
XMBEffect_AddAbilityCharges - Adds extra charges to an ability or abilities
XMBEffect_AddItemChargesBySlot - Adds extra charges to items in certain slots, like Heavy Ordnance but more general
XMBEffect_AddUtilityItem - Adds a bonus utility item that lasts for the duration of the mission then disappears
XMBEffect_BonusDamageByDamageType - Grants bonus damage on attacks and damage-over-time of a specific elemental damage type
XMBEffect_BonusRadius - Increases the radius of grenades of a specific type, or of all grenades
XMBEffect_ChangeHitResultForAttacker -Changes the result of an attack after all other hit calculations
XMBEffect_ConditionalBonus - Grants attack and/or defense bonuses based on conditions
XMBEffect_DoNotConsumeAllPoints - Makes another ability not end the turn when used
XMBEffect_PermanentStatChange - Permanently changes the base stats of a unit
XMBEffect_Extended - Base class for defining your own X2Effects with additional functions to override
XMBEffect_RevealUnit - Makes a unit visible on the map
XMBEffect_ToHitModifierByRange - Modifies to-hit based on range to target and conditions