Home

Roxxploxx Modding Guide - Welcome!

Where RimWorld modders come to get started... or not, I mean I dunno. There might be something useful around here...

This guide is for the modders of RimWorld. There are many guides out there but with spotty coverage of topics (from thin to outstanding) or at different technical levels. I will try to focus on high-level understanding and style, over step-by-step instructions.

Modding is a great way to play RimWorld and to customize it to your needs and joys! Have fun.

• Getting Started at Modding
• Key Points of Understanding
• Development Gotchas
• Short Tutorials

NOTE: I love feedback, so find me on Discord : Roxxploxx.

And, if you're finding this helpful? Support me on Patreon. Thanks!

---

Short Tutorials

These tutorials are not comprehensive but you should get you up and running with the topic. Basically, this is what I needed to know before I could do anything useful on the topic...

Basics and Good-To-Knows

• The Basics of Modding - Read this first.
• Make a Component - Make a useful, reusable, nugget of functionality.
• Things and ThingDef and Components - How are objects/classes/comps handled?
• Facilities - Facilities link furniture and other items together. ex. lamp and power
• Color Mask Guide [external link - by Sera] - How RimWorld colors your images
• How Pawns Think - An overview on ThingTree, Jobs, JobDrivers and Toils.
  • Jobs and Work - stub page only - a bit about creating them
• Mac Modding HowTo - I use a Mac, you can too.

More In-Depth

• User Interface - in progress - a tutorial on modding the GUI system of RimWorld
  • Add A Tab - add a tab that displays when a Thing is selected. ex. on a Pawn, they are 'Character', 'Gear', 'Social', etc.
  • Widgets - how to build UIs with RimWorld's Widgets (hint, use Cards!)
• Jec'sTools - Jecrell has done some great work putting these drop-in DLLs together for us
  • CompSlotLoadable - add slots to items (i.e. gems, ammo, etc.)
  • CompAbilityUser - Add abilities to Pawns that can be clicked on. ex. spells, jedi abilities
  • CompActivatableEffect- Add items with effects that can be turned on/off. ex. activate lightsabers
  • CompToggleDef - A situational Component that allows you to toggle the ThingDef of a selected Thing via a radio button menu. ex. Change a ring to be for a pinky finger versus a ring or index finger.
• WorldComponent and GameComponent - in progress Add map behaviors.
• ExtendedThings - outdated* - Extend anything with Component-like functionality.

Advanced Topics

• DefPatches [external link - by Zhentar] - Modify existing items with XSLT translations in A17
  • More on DefPatches - additional information
• Harmony - Using harmony for non-destructive detouring of code... i.e. modify existing RimWorld code.

---

Old and Out of Date Pages