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. While most of this wiki was updated for 1.0, 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.

Getting Started

1. Setting up your first mod

2. Changing simple traits of things

3. Creating a new thing (XML only)

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
   • Assemblies folder
   • Languages folder
   • Textures folder
   • Sounds folder
   • Patches folder
5. Recommended Software
6. Modding Troubleshooting Tips and Guides

General modding

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

Must-knows

• Modifying Defs
• Troubleshooting mods

XML tutorials

1. XML File Structure
2. Introduction to XML Defs
   • XML Def Compatibility
   • Auto Documentation
3. In-depth XML Def tutorials
   • ThingDef explained
   • Weapons_Guns.xml explained. Slightly dated.
4. PatchOperations, replace specific xml elements of core files while keeping the rest untampered. Uses xpath.

C# tutorials

1. Setting up
2. Hello World
3. Decompiling Source Code
4. Writing Custom Code
5. Linking XML and C#
6. Alter Code at Runtime with Harmony - this is a best practice for modifying game code, replacing C# code injection to reduce Mod Conflicts
7. The wonderful things you will want to do with C#
   • Adding fields and methods to classes
8. Useful things:
   • Mod settings - Add settings to your mod
   • Def mod extensions - Add (custom) fields to Defs
   • Custom Comp Classes - A quick overview of what types of Comps there are, and what they're suited for.
     • ThingComp - Learn all there is to know about ThingComps.
     • Components - GameComponents, WorldComponents, and MapComponents
   • Introduction to Def Classes
   • Using Harmony to optionally patch other mods for the sake of compatibility
   • TweakValues - Change values on the fly (handy for quick iteration!)
   • ExposeData - Save stuff
   • The big ass list of useful classes - A non-exhaustive list of classes you'll use most
   • Grammar Resolver - PAWN_objective, PAWN_possessive? Find out what it all means here.
   • ExampleJob - Mehni's top to bottom breakdown of Jobs.

Art Tutorials

• Artstyle - Officially unofficial guide to RimWorld's Artstyle
• Ekksu's guide to creating RimWorld animals
• ChickenPlucker's guide to creating apparel
• Seraphile's guide to masks

Examples

• Assembly Modding
• The Plague Gun tutorial originally by Jecrell, updated to 1.1+.

Dangerously Outdated

• Modding Tutorials/Smelter
• Modding Tutorials/Items
• Modding Tutorials/Weapons
• Modding Tutorials/Furniture
• The Plague Gun based on the Plague Gun tutorial by Jecrell, updated for 1.0. Thread.

1. Required Items
2. XML Stage
3. Connecting XML and C#
4. C# Assembly Setup
5. C# Coding
6. Localisation

See also

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