BmSDK is a C# scripting system for Batman: Arkham City, allowing mods to add custom gameplay and logic. BmSDK provides a full game-mapped API and SDK (RPlayerController, WorldInfo, RGameRI, etc.) and a set of utilities for interacting with the game world. It also provides lifecycle and input events (script start, enter menu/game, tick, button press, etc). Check out the wiki for more info!
If you're a user (meaning you just want to run script mods, not make them), getting started is simple:
- Go to https://dotnet.microsoft.com/en-us/download and install the .NET 10 SDK if you haven't already. Make sure you get the 32-bit version (x86), even if you have a 64-bit computer.
- Download the latest release from releases and open the .zip file.
- Inside you'll see two folders:
BinariesandBmGame. Copy both to your game folder (likelyC:\Program Files\Epic Games\BatmanArkhamCity). There should already be 2 folders in there with the same names. - Done, BmSDK is installed! Now to install script mods, simply drop any .cs files into your
BmGame\Scriptsfolder.
Keep in mind that script mods can potentially harm your computer. Make sure you only download and install scripts from trusted sources.
If you have a Steam/GOG copy of the game, you'll have to install a compatibility patch. You can find it next to the latest release. Just extract the ZIP and drop the Binaries folder in the game directory. Replace BatmanAC.exe when prompted - it's a good idea to make a backup first.
Follow these steps to set up the development environment so you can build, run, and debug mods for the game:
- Go to visualstudio.microsoft.com/downloads and run the Visual Studio Installer.
- In the Visual Studio Installer: Pick ".NET desktop development" from the "Workloads" tab.
- Follow all the steps for the user setup except installing the .NET 10 SDK as it's included with Visual Studio.
- Start Visual Studio and open the solution in
%GameDir%\BmGame\ScriptsDev. - Write your code in
MinimalScript.csor any other C# source file in%GameDir%\BmGame\Scripts. - Test your code by pressing F5 in Visual Studio (Running the BatmanAC debug profile).
- Follow the wiki to write your first script.
- Sometimes the game window never shows up. In that case try Alt + Tab to focus it. If that doesn't work, press Ctrl + Shift + F5 (Restart debugging) in Visual Studio.
To set up your development environment so you can modify, build and execute the BmSDK repository, follow the wiki page: Building BmSDK
BmSDK is licenced under the MIT licence.
