The mod loader only supports Windows systems. There's no plan for Mac, Linux, or Switch support at the moment. This can change in the future with help from the game's developers, or an experienced C++ programmer to alter the DLLs.
Installation
Extract the downloaded zip file into the game's base directory (the one containing the executable file), overwriting files as necessary. After doing so, start the game. When you get to the main menu, there should be an additional button in the main menu reading Mod Content, as well as mod loader version string in the bottom-right corner.
If you're upgrading from a previous version of the mod loader, you can simply follow the above steps again. In case of issues, try validating integrity of game cache (if on Steam), or reinstalling the game. Then install the mod loader again.
Uninstallation
To uninstall the mod loader, run
uninstall.bat
. This script will restore your Into the Breach installation to unmodded state. Profiles, savegames, and mods present in mods
direcory will be left untouched.Keep in mind that savegames that used mods will be broken to a varying degree depending on which mods were enabled. Profiles used to play mods will most likely work for new games, but entering the statistics screen in main menu might cause the game to crash.
If problems persist, try validating integrity of game cache (if on Steam), or reinstalling the game.
Usage
The game stores various data in the profile file, therefore it is recommended to use a separate profile for your modding ventures. Otherwise you risk losing your unlocks in case things go wrong.
To install mods, simply unpack them into the
mods
folder in the game's base directory.To access some functionalities of the mod loader, like configuration, etc., click on the Mod Content button in the main menu after starting the game.
Help & creating mods
If you're interested in creating mods, be sure to join the Into the Breach Discord server, and hang out in the
#modding-creation
and #modding-discussion
channels. They are a very useful place when it comes to getting help on how to do things, and accessing the general body of knowledge compiled by the community so far.If you're looking for a place to start, this Google doc contains a few tutorials.
If you're an advanced modder, documentation of all additional features provided by the mod loader and the mod API can be found on the mod loader's Github Wiki.
See also