Modding Tutorials

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

---

This is the hub page for tutorials, guides, and reference materials for creating mods for RimWorld. As RimWorld does not have a formal modding API, nearly all of the information here has been gathered and maintained by the modding community.

NOTE: (2023-06-12) As of the time of this writing, the modding section of the RimWorld Wiki is currently undergoing a major overhaul. New content is being written and older tutorials and guides are being revised or deleted. Please be patient while this overhaul takes place.

---

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
   • 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

Steam Workshop Specifics

• If you want to upload your mod to the Steam Workshop you must own the game on Steam. Owning it on Epic or GoG etc is not enough, both Steam and Tynan have confirmed this.
• Your Preview.png must be under 1MB to upload to the Steam Workshop otherwise you will see "Error : Limit Exceeded"
• Steam mod descriptions don't use markdown, they use a form of BBCode. There is a guide.

Updated guides

These guides have been made with the most recent version of Rimworld in mind and are being updated to reflect changes in the game.

1. Getting Started With XML
2. Adding a New Weapon, Trait and Research to the game
3. Making Patches using Xml

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.
   • Config Errors - Provide configuration issues to the user on startup.
   • Debug Actions - Call methods from the debug menu
9. Getting started with RimWorld modding on Linux

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

Under construction

These tutorials are under construction.

• Modding Tutorials/Quests
• Modding Tutorials/Troubleshooting/Finding Exceptions

Examples

• RimWorld 1.3: XML Mod Creation
• Assembly Modding
• The Plague Gun tutorial originally by Jecrell, updated to 1.1+.
• Modding Tutorials/Xenotype template originally by Ryflamer

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