Zlepper.RimWorld.ModSdk.Testing 0.0.9

RimWorld ModSdk for unit testing

This is a variant of the Zlepper.RimWorld.ModSdk package, which is used for unit testing. It is not intended to be used for actual mod development. I would recommend reading the documentation for that package first, and then come back here.

This package enables using testing through NUnit. If you want to use XUnit or equivalent, you will have to do some work yourself. I have not tested this with other testing frameworks, but it should be possible to get it working with some tweaking.

Installation

Like for the normal ModSdk you have to create a new project, but instead you use this configuration in the .csproj file:

<Project Sdk="Zlepper.RimWorld.ModSdk.Testing/0.0.9">
    <ItemGroup>
        <ProjectReference Include="..\MyMod\MyMod.csproj"/>
    </ItemGroup>
</Project>

This assumes that you have a project called MyMod in the same solution, which is the project you want to test.

Now you can start writing your NUnit tests as you always do.

Configuration

There a fewer configuration than for the normal ModSdk since you don't need to run something, so here is just an overview of the settings:

<PropertyGroup>
    
    <Nullable>enable</Nullable>

    

    <LangVersion>10</LangVersion>

    
    <RimWorldImplicitUsings>enable</RimWorldImplicitUsings>

    

    <RimWorldPath>C:\Program Files (x86)\Steam\steamapps\common\RimWorld</RimWorldPath>

</PropertyGroup>

Adding a reference to a RimWorld assembly

By default the SDK references Assembly-CSharp and UnityEngine.CoreModule for you. If you need to reference another assembly, you can do so by adding a reference to it in the project file. For example, if you want to reference UnityEngine.IMGUIModule, you can add the following to your project file. Sadly these kind of references are not transitively inherited from the mod project itself, so you have to repeat them here again.

<ItemGroup>
    <RimWorldAssemblyReference Include="UnityEngine.IMGUIModule"/>
</ItemGroup>