Modding Tutorials/Overhaul workspaceLast updated 9 days ago

?

Under Review

This tutorial or guide is currently undergoing review and should not be considered ready to use.

NOTE: This is a workspace for the ongoing overhaul of the RimWorld Wiki's modding tutorials and references. If you managed to find your way here, please check out the main modding tutorials index page instead.

This overhaul is being overseen by the #mod-development channel on the RimWorld Discord, please contact us before changing anything.

Modding Basics

Modding Basics

• Getting Started
• Recommended Software
• Mod Folder Structure
• About.xml
• Textures
• Sounds
• Localization

XML

• Defs
• ThingDef
• MayRequire
• PatchOperations

C#

• C# Basics
• Decompiling Source Code - Reading compiled code from the base game as well as DLCs and other mods.
• Setting up - (Needs cleanup)
• Harmony Primer

Code References

• Infrastructure Overview
• Application Startup
• Simulation Lifecycle
• Rendering Lifecycle
• Buildings
• Pawns
• Audio

Tutorials

This will be a curated subset of tutorials that will be vetted, reviewed, and maintained by the overhaul team. These are meant to be a cohesive set of tutorials that guides the reader from the simplest single-Def items such as weapons to building a full custom faction.

Basic Tutorials (XML)

• Creating a custom melee weapon
• Creating a custom ranged weapon
• Creating a custom plant
• Creating a custom animal
• Creating a simple building
• Creating a custom workbench
• Creating a custom drug

Advanced Tutorials (XML)

• Creating a custom faction
• Creating a custom culture
• Creating a custom trader type

Basic Tutorials (C#)

• Creating a custom consumable

Advanced Tutorials (C#)

• Creating custom texture overlays

Banner Templates

?

Under Review

This tutorial or guide is currently undergoing review and should not be considered ready to use.

{{:Modding_Tutorials/Under_Review}}

!

Marked for Deletion

This tutorial or guide is not up to the new standards of the RimWorld Wiki tutorial team and has been marked for deletion pending release of newer content that covers the same topic. Please be aware that this page may contain inaccuracies or errors; if you are the author of this page and have questions about this process, please contact us on the #mod-development channel of the RimWorld Discord.

{{:Modding_Tutorials/Marked_for_Deletion}}

!

Obsolete

The following content was written for a previous version of RimWorld or is otherwise no longer fully relevant today. Please be mindful of any potential inaccuracies.

{{:Modding_Tutorials/Obsolete}}