Modding Tutorials

Basics Menus Game Creation Gameplay Pawns Plants Resources Gear Mods Modding Modding Tutorials

---

This is the table of contents for the modding tutorial. Here, you'll learn step by step how to create mods of gradually increasing complexity.

In light of little official documentation, most of the knowledge here was gained by experience, trial-and-error, decompiling and learning from the source. Keep in mind that RimWorld is a big game that underwent substantial code changes during its alphas. Some information you find may be outdated.

---

What's a mod?

A mod is a folder containing data the game reads/loads. Mods can add, remove or alter the content of other mods (including the Core mod) in the broadest sense of the word. For more info, see also Modding.

Introduction to modding

1. First Steps and Some Links
2. Essence of Modding
3. Exploring the Folder Structure
4. Mod Folder Structure
   • About folder
   • Defs folder
   • Languages folder
   • Textures folder
   • Sounds folder
5. Recommended Software

General modding

• Testing Mods
  • Development Mode
• Adding and Testing Sounds
• Decompiling Texture/Sound Assets

XML tutorials

1. XML File Structure
2. Introduction to XML Defs
   • XML Def Compatibility
3. In-depth XML Def tutorials
   • Weapons_Guns.xml Explained
4. (Added in Alpha 17) PatchOperations, replace specific xml elements of core files while keeping the rest untampered

C# tutorials

1. Setting up
2. Decompiling Source Code
3. Writing Custom Code
4. Introduction to Def Classes
   • Def Class Compatibility
5. Alter Code at Runtime with Harmony - this is a best practice for modifying game code, replacing C# code injection to reduce Mod Conflicts
6. Mod DLL Compatibility
   • C# Injection
7. Distribution
   
   

Examples:

• Assembly Modding

See also

• Roxxploxx's set of modding tutorials
• RimWorld Modding Resources - A hub for guides, modders, practical tips