Developer Notes

Developer notes

Git Flow

I use git flow for managing the repository, which means:

• The master branch is always build-able and represents the latest version.
• The develop branch is a working branch: it may or may not build and if it build if might not work as intended.
• feature\ branch are ongoing work, do not expect them to build or work.

Building the Mod

The mod is quite easy to build as (mostly) everything is automatic. You need:

• A C# compiler (e.g Visual Studio to open the .sln file)
• Python 3.6 (at least)
  • Make sure this python version is in your path
• Open the solution and go to project properties

In the Post-build event command line, you should see something like this:

if $(ConfigurationName) == Debug python $(ProjectDir)tools\pdb2mdb.py $(TargetPath)

if $(ConfigurationName) == Debug python $(ProjectDir)tools\copy_to_rimworld.py $(TargetDir) I:\rimworld_debug\RimWorld --output_dir $(ProjectDir)output\$(TargetName) --pdb --mdb

if $(ConfigurationName) == Release xcopy $(TargetPath) $(ProjectDir)output\PrepareLanding\Assemblies

Simply replace the hard-coded path (I:\rimworld_debug\RimWorld) with your own path to your RimWorld game location. The python scripts will copy all files from the mod to the RimWorld location.Please note that it works only for a debug configuration.

For a release configuration the mod folder is in \output directory at the root of the repository (same as in debug but no copy to the Rimworld game folder occurs).