ir-example-mod

This is an Interstellar Rift example mod for the Interstellar Modder mod loader containing two simple patches:

• One logs when the player clicks the main menu Play button
• One logs when Game.Program.Stop runs during shutdown

And dummy content files.

Prerequisites

1. Export the game references from the loader repo:

dotnet run --project ../interstellar-modder/src/IRModTool -- export \
  --game-root "/path/to/Interstellar Rift" \
  --export-root "../interstellar-rift-export"

2. Build the loader so IRModLoader.dll exists:

dotnet build ../interstellar-modder/src/IRModLoader/IRModLoader.csproj

3. Create Local.props from Local.props.example and set your local paths there.

Example:

<Project>
  <PropertyGroup>
    <InterstellarRiftExportRoot>../interstellar-rift-export</InterstellarRiftExportRoot>
    <InterstellarModLoaderRoot>../interstellar-modder/src/IRModLoader/bin/Debug/net472</InterstellarModLoaderRoot>
  </PropertyGroup>
</Project>

Local.props is in the .gitignore so each developer can configure their own machine without editing the project file.

Build

It is recommended to use the Nix devshell to get the required tooling.

nix develop

If you wish to not use Nix, you will need dotnet SDK 8, NuGet, and zip.

Then

dotnet build

Or build a complete mod package:

make

make writes:

• dist/example-ir-example-mod-1.0.0/
• dist/example-ir-example-mod-1.0.0.zip

Expected Log

After launching and then closing the game, the loader should create:

• mods/logs/example-ir-example-mod/<timestamp>.log

It should contain:

• Initialized example patches.
• Main menu Play button clicked. eventCode=1, intMessageData=0
• Game.Program.Stop postfix ran.