cookiecutter-rimworld-mod-development

A cookiecutter project that builds the basic Rimworld mod development file structure and sets up a sane build environment.

Table of Contents

• Install/Setup
  • Windows Command Prompt
    • Required Programs
    • Usage
  • Microsoft Visual Studio Integration
    • Required Programs
    • Usage
• Basic Features
  • Folder Structure
  • VS Setup Automation

Install/Setup

Windows Command Prompt

Required Programs

• git
• python
• cookiecutter (or pip install cookiecutter)

Usage (inside Rimworld/Mods folder)

1. cookiecutter gh:feldoh/cookiecutter-rimworld-mod-development
2. [Answer the prompts]
   1. Note that when it asks you _visual_studio you must respond {}
3. Open the folder you just created and double-click the ModName.sln file
4. In the Solution Explorer view on the right, right click RimWorldWin and click Set as Startup Project

Microsoft Visual Studio Integration

Required Programs

• Visual Studio Community

Install (if no File -> New -> From Cookiecutter... option is available)

1. Open up VS Installer (In Visual Studio -> Tools -> Gets Tools and Features)
2. Click Modify
3. Click Individual Components
4. Scroll to Development activities
5. Click the Cookiecutter template support checkbox
6. Click Modify

Usage

1. Open Visual Studio
2. File -> New -> From Cookiecutter...
3. Search for rimworld
4. Double-click feldoh/cookiecutter-rimworld-mod-development
5. Change the Template Options:
   • Create To => [...]/RimWorld/Mods
   • Mod name
   • Author (Use your Steam username for automatic linking of mod to profile) (can change later in About-Release.xml)
   • Mod Description (not required, can change later in About-Release.xml)
   • A few more options are available
6. Create and Open Project

Basic Features

Folder Structure

This cookiecutter builds the entire standard mod folder structure, with empty folders as the default. namespace_name is automatically calculated.

• {{cookiecutter.mod_name}}
  • About
    • About.xml
    • Preview.png
  • 1.X
    • Assemblies
    • Defs
    • Patches
    • Source
      • namespace_name
        • Properties
          • AssemblyInfo.cs
        • Settings.cs
        • namespace_nameMod.cs
        • namespace_nameDefOf.cs
        • namespace_name.csproj
      • namespace_name.sln
  • Common
    • Languages
      • English
        • Keyed
          • namespace_name_Misc_Gameplay.xml
    • Sounds
    • Textures
  • README.md
  • LICENSE
  • .gitignore
  • .gitattributes
  • .editorconfig

Note that samples demonstrating use of MayRequire and Loadfolders use Royalty as an example, simply swap this out as you need.

Preview images

A preview image Asset is provided as a Krita file you may wish to use Krita which is a free art tool or something else. The template provided uses the Rimworld Font from Marnador. Make sure to export as a png file and place the Preview.png in About/Preview.png

VS Setup Automation

• Links Rimworld and UnityEngine .dlls for importing in code
• Sets build events to automate file management of About-$Version.xml for tagging development versions.
• Clears the default set trace constant
• Creates a VS solution with correctly defined paths
• Clicking Start ▶️ will preform the designated build sequence and start Rimworld.exe tied to a Visual Studio resource monitor.

Issues

The imported project "C:\Program Files (x86)...\Microsoft.CSharp.Core.targets" was not found

If you're not using Visual Studio you may need to tell the project where your MS Build actually is.

• You can download MSBuild from Microsoft
• It will already be in your Rider directory and can be found under File -> Settings -> Build, Execution, Deployment -> Toolset and Build -> MSBuild Version

Cannot Resolve Symbol HarmonyLib (using HarmonyLib is red)

Run dotnet restore on the .csproj file for your code then try re-doing the nuget restore.

Thanks

• alextd and n-fisher for the prior version of this template
• Marnador for the Rimworld Font