MurderModLoader.API 0.1.10

murder-mod-loader

Mod loader for Murder Engine games. Uses Harmony for runtime method patching.

Requirements

• murder-unpack (uv tool install murder-unpack)
• .NET 8 SDK matching the game's architecture (x64 game needs x64 SDK)

Installation

Install the tools

# Install murder-unpack (bundle extraction)
uv tool install murder-unpack

# Install the mod loader installer
dotnet tool install -g murder-mod-install

Install into a game

# Auto-detects SDK, extracts bundle, sets up mod loader
murder-mod-install "/path/to/game"

# macOS .app bundles are also supported
murder-mod-install "/path/to/Game.app"

# Specify .NET SDK path manually if needed
murder-mod-install "/path/to/game" "/path/to/dotnet-sdk-8.0"

Launch

/path/to/game/launch-modded.sh    # Linux / macOS
/path/to/game/launch-modded.bat   # Windows

Installing Mods

# From NuGet
murder-mod-install add nuget:MyMod "/path/to/game"
murder-mod-install add nuget:MyMod@1.0.0 "/path/to/game"

# From a git repository
murder-mod-install add git:https://github.com/user/my-mod "/path/to/game"

# From a zip URL (e.g., GitHub release)
murder-mod-install add https://github.com/user/my-mod/releases/download/v1.0/my-mod-windows.zip "/path/to/game"

# From a local zip file
murder-mod-install add ./my-mod.zip "/path/to/game"

Git sources are built automatically if the repository contains a .csproj.

Disabling a mod

Place a .disabled file in the mod's directory, or set Enabled: false in mod.yaml.

Creating a Mod

Create a directory with mod.yaml and a C# project:

# mod.yaml
Id: my-mod
Name: My Mod
Version: 1.0.0
DLL: MyMod.dll

using HarmonyLib;
using MurderModLoader.API;

public class MyMod : IMurderMod
{
    private Harmony? _harmony;
    public void OnLoad(ModContext context)
    {
        _harmony = new Harmony(context.HarmonyId);
        _harmony.PatchAll(context.ModAssembly);
    }
    public void OnUnload() => _harmony?.UnpatchAll(_harmony.Id);
}

Reference the mod API in your .csproj:

<PackageReference Include="MurderModLoader.API" Version="0.1.*" />

For game type references (Murder, Bang, FNA), set GameAssemblyPath in your .csproj to the game's .modded/ directory, or let the build command handle it.

Build and install from source

murder-mod-install build <mod-dir> <game-dir>

Publishing a mod

Mods can be distributed as:

• NuGet package -- include mod.yaml and DLLs in a NuGet package
• Git repository -- include mod.yaml and either source (.csproj) or pre-built DLLs
• Zip file -- zip the mod folder containing mod.yaml and DLLs

Building from Source

git clone https://github.com/yuna0x0/murder-mod-loader.git
cd murder-mod-loader
dotnet build

# Run the installer directly from source
dotnet run --project src/MurderModLoader.Installer -- <game-dir>
dotnet run --project src/MurderModLoader.Installer -- build <mod-dir> <game-dir>
dotnet run --project src/MurderModLoader.Installer -- add <source> <game-dir>

Limitations

• SingleFileBundle only -- NativeAOT games can't be patched at runtime
• Architecture match -- the .NET SDK must match the game (x64 game needs x64 SDK)

License

MIT