Difference between revisions of "Modding Tutorials"

From RimWorld Wiki
Jump to navigation Jump to search
Line 19: Line 19:
 
# [[Modding Tutorials/Folder structure|Exploring the Folder Structure]]
 
# [[Modding Tutorials/Folder structure|Exploring the Folder Structure]]
 
# [[Modding Tutorials/Mod folder structure|Mod Folder Structure]]
 
# [[Modding Tutorials/Mod folder structure|Mod Folder Structure]]
#* [[Modding Tutorials/About folder|About folder]]
+
#* [[Modding Tutorials/Mod folder structure#The About folder|About folder]]
#* [[Modding Tutorials/Defs folder|Defs folder]]
+
#* [[Modding Tutorials/Mod folder structure#The Defs folder|Defs folder]]
#* [[Modding Tutorials/Languages folder|Languages folder]]
+
#* [[Modding Tutorials/Mod folder structure#The Source and Assemblies folders|Assemblies folder]]
#* [[Modding Tutorials/Textures folder|Textures folder]]
+
#* [[Modding Tutorials/Mod folder structure#The Languages folder|Languages folder]]
#* [[Modding Tutorials/Sounds folder|Sounds folder]]
+
#* [[Modding Tutorials/Mod folder structure#The Textures and Sounds folders|Textures folder]]
 +
#* [[Modding Tutorials/Mod folder structure#The Textures and Sounds folders|Sounds folder]]
 +
#* [[Modding Tutorials/Mod folder structure#The Patches folder|Patches folder]]
 
# [[Modding Tutorials/Recommended software|Recommended Software]]
 
# [[Modding Tutorials/Recommended software|Recommended Software]]
  

Revision as of 14:04, 23 January 2019

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

Introduction to modding

  1. First Steps and Some Links
  2. Essence of Modding
  3. Exploring the Folder Structure
  4. Mod Folder Structure
  5. Recommended Software

General modding

XML tutorials

  1. XML File Structure
  2. Introduction to XML Defs
  3. In-depth XML Def tutorials
  4. (Added in Alpha 17) PatchOperations, replace specific xml elements of core files while keeping the rest untampered

C# tutorials

  1. Setting up
  2. Hello World
  3. Decompiling Source Code
  4. Writing Custom Code
  5. Introduction to Def Classes
  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. Mod DLL Compatibility
  8. Distribution

Examples:

See also