RimWorld Modding Resources

Updating to 0.19/1.0

• Tynan’s forum post for 0.19
• Python script to convert graphic_multi texture files to the correct extension (from _back to _north_side to _eastand _front to _south)

Getting set up

• Picking a text editor - Whichever you useuse the find in files option.
• Recommended decompilers:
  • dnSpy - feature-rich and often updated.
    • dnSpy can be used to debug Unity games that you can’t usually debug. Read hereremember to download the Unity-debugging-win32.zip from releases
  • ILSpy - fast and simple.
    • The official release has now surpassed Zhentar’s old fork previously favoured by the community.
  • dotPeek - primarily useful when transpiling because of its synchronised IL and C# view.
• Setting up a solution for RimWorld or setting up Visual Studio. You’ll need to be able to target the .NET 3.5 framework to mod RimWorld.
• fyarn’s Rimworld Mod Development Cookiecutter: Set up a fully functional mod development environment in 30 seconds or less with a Visual Studio integration
• Things you might not know

Getting set up: Tips for C# on Linux

For masochists like me who prefer to make mods on Linuxhere are a few resources to hopefully make your life a bit easier. Or not.

• Rubenwardy’s blog post from 2016 detailing a Debian setup of Mono and MonoDevelop
• My MonoDevelop setup on Arch (and also how to run ILSpy on WINE)

General

• Modding tutorials page on the RimWorld wiki
• Mod Help section on the ludeon forums
• Roxxploxx’s modding guide
• Jecrell’s step-by-step modding guide
• ZorbaTHut’s intro to modding features
• KeenKrozzy’s Guide to using custom textures
• GitHub repositories of modders
• RimWorld fontcourtesy of Marnador

XML

• Abstracts and inheritance - AKA “what the hell am I copy-pasting over anyway?”
• Zhentar’s Introduction to PatchOperation: using xpath to target parts of Defs.
• RimWorld XML Auto-Documentation - an HTML help file for modders. It contains a listing of all Core (ie. vanilla) uses of RimWorld’s XML code. It’s great for learning what tags are parents or children of what.
• Background information
  • W3Schools introduction to xpath - RW does not support all featuresbut this teaches you a lot.
  • W3Schools introduction to basic XML - Read up to and including the “Attributes” article.

C#

• Learn C# from Microsoft Virtual Academy
• The Harmony Wiki
• Brrainz’s introduction to transpiling with Harmony
• Why_is_that’s guide to Mod Settings
• Mehni’s top to bottom breakdown of the Job system
• Guide to saving stuff using ExposeData
• Attaching a debugger
• Ideas for a first project

Graphics

• Seraphile’s Open source graphic resources & wiki
• Seraphile’s guide to colouring images and masks
• Chicken Plucker’s guide to creating apparel - Includes templates.
• CannibalRechter’s CompFX for animated textures
• Officially unofficial art guide
• Latest art assets can be found in #rimworld-art on the discord. Or ask.