The mod loader is a collection of lua scripts and DLL libraries, providing a framework that loads mods and empowers them with additional features.
This is a continuation of Cyberboy2000's mod loader, which was originally posted here. Seeing as he's been unreachable for quite a while, I decided to take over the deveopment to fix bugs and implement new features.
GitHub repository can be found here.
Download link: [ Version 2.5.4 ]
Release page with changelog
A list of all previous releases can be found here.
Extract the zip file into the game's base directory (eg. for Steam, this is typically C:\Program Files (x86)\Steam\steamapps\common\Into the Breach), next to the game's executable, overwriting files as necessary. The zip includes original copies of the overwritten files so you can easily revert, if need be.
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 and encounter issues, the nuclear option of doing a clean reinstall of the game will solve all of them.
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.
After that, the game should be back to unmodded state. If you get any errors despite following these steps, try validating integrity of game cache (if on Steam), or reinstalling the game.
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 the Mod Content button in main menu after starting the game.
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 includes 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 here.
Frequently Asked Questions
- I've downloaded the mod loader and some mods, and installed them - the mod loader shows up in-game, but I can't see any mods!
Most likely you've put the mod files in the wrong folder (resources/mods). The mod loader package includes an empty folder called mods, and it seems it gets ignored by some unpacking tools. If there's no mods folder in the game's root directory, simply create it yourself and put the mods there. This picture should illustrate it.
- Does the mod loader work on systems other than Windows? (once ITB is released on other platforms)
The lua part of the mod loader does, but the additional features in the form of DLLs most likely won't. Unfortunately, I do not have enough C++ expertise to do anything about this.
However, people have been reporting good results using emulation software like Wine.
- Some parts of the modded UI are obviously misplaced or incorrectly sized, why is that?
You're likely playing with Stretch Scaling enabled. The mod loader's GUI code does not account for it. I'm trying to work out a solution, but it's going very slowly. For now, to fix this issue on your end, you have to disable this option.