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 will assist people trying to mod RimWorld, especially those doing more advanced modding. 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 approaches to deeper understanding over step-by-step instruction.

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.

Short Tutorials

These tutorials are meant to get you up and running with the topics. They are not comprehensive but after going through them, you should be able to figure the rest of it out. Basically, this is what I needed to know before I could do anything useful on this topic...

Basics and Good-To-Knows

• The Basics of Modding - Read this first.
• Mac Modding HowTo - I use a Mac, you can too.
• Things and ThingDef and Components - How are objects/classes/comps handled?
• Extend Thingdef - When you want to add new tags/attributes to an XML description.
• Make a Component - Make a useful, reusable, nugget of functionality.
• Facilities - Facilities link furniture and other items together. ex. lamp and power
• Color Mask Guide [external link - by Sera] - How RimWorld colors your images

More In-Depth

• ExtendedThings - Extend anything with Component-like functionality.
• JobDefs - a bit about creating them
• 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!)
• Add Abilities to Pawns - 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
• WorldComponent and GameComponent - in progress Add map behaviors.

Advanced Topics

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