Difference between revisions of "Modding Tutorials"

From RimWorld Wiki
Jump to navigation Jump to search
(→‎Table of contents: Added uniform capitalization on the links)
m
(31 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 
<!--Top Nav Box-->
 
<!--Top Nav Box-->
{| align=center
 
! {{MainSection_Nav}}
 
|}
 
 
{| align=center
 
{| align=center
 
| {{Mods_Nav}}
 
| {{Mods_Nav}}
Line 16: Line 13:
 
===Introduction===
 
===Introduction===
  
 +
# [[Modding Tutorials/First Steps|First Steps and Some Links]]
 +
# [[Modding Tutorials/Essence| Essence of Modding]]
 
# [[Installing mods|Installing Mods]]
 
# [[Installing mods|Installing Mods]]
 
# [[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/Defs folder|Defs folder]]
 +
#* [[Modding Tutorials/Languages folder|Languages folder]]
 +
#* [[Modding Tutorials/Textures folder|Textures folder]]
 +
#* [[Modding Tutorials/Sounds folder|Sounds folder]]
 
# [[Modding Tutorials/Recommended software|Recommended Software]]
 
# [[Modding Tutorials/Recommended software|Recommended Software]]
  
Line 25: Line 29:
 
* [[Modding Tutorials/Testing mods|Testing Mods]]
 
* [[Modding Tutorials/Testing mods|Testing Mods]]
 
** [[Modding Tutorials/Development mode|Development Mode]]
 
** [[Modding Tutorials/Development mode|Development Mode]]
 +
* [[Modding Tutorials/Sounds|Adding and Testing Sounds]]
 +
* [[Modding Tutorials/Assets|Decompiling Texture/Sound Assets]]
  
 
===XML tutorials===
 
===XML tutorials===
  
 
# [[Modding Tutorials/XML file structure|XML File Structure]]
 
# [[Modding Tutorials/XML file structure|XML File Structure]]
 +
# [[Modding Tutorials/XML Defs|Introduction to XML Defs]]
 +
#* [[Modding Tutorials/Compatibility with defs|XML Def Compatibility]]
 +
# In-depth XML Def tutorials
 
#* [[Modding Tutorials/Weapons Guns|Weapons_Guns.xml Explained]]
 
#* [[Modding Tutorials/Weapons Guns|Weapons_Guns.xml Explained]]
# [[Modding Tutorials/Compatibility with defs|Compatibility with Existing Defs]]
+
# (Added in Alpha 17) [[Modding Tutorials/PatchOperations|PatchOperations]], replace specific xml elements of core files while keeping the rest untampered
# [[Modding Tutorials/Sounds|Adding and Testing Sounds]]<br/><br/>
 
 
 
''The following tutorials are likely outdated''
 
* [[Modding Tutorials/Getting Started|Getting Started]]
 
* [[Modding Tutorials/Items|Items]]
 
* [[Modding Tutorials/Flooring|Flooring]]
 
* [[Modding Tutorials/Weapons|Weapons]]
 
* [[Modding Tutorials/Furniture|Buildings and Furniture]]
 
* [[Modding Tutorials/Plants|Plants]]
 
* [[Modding Tutorials/Food|Food]]
 
* [[Modding Tutorials/Races and Pawns|Races and Pawns]]
 
* [[Modding_Tutorials/Smelter|Buildings and Furniture: Creating a Smelter]]
 
  
 
===C# tutorials===
 
===C# tutorials===
Line 48: Line 45:
 
# [[Modding_Tutorials/Decompiling source code|Decompiling Source Code]]
 
# [[Modding_Tutorials/Decompiling source code|Decompiling Source Code]]
 
# [[Modding_Tutorials/Writing custom code|Writing Custom Code]]
 
# [[Modding_Tutorials/Writing custom code|Writing Custom Code]]
 +
# [[Modding_Tutorials/Def classes|Introduction to Def Classes]]
 +
#* [[Modding_Tutorials/Modifying defs|Def Class Compatibility]]
 +
# [[Modding_Tutorials/Harmony | Alter Code at Runtime with Harmony]] - this is a best practice, replacing C# code injection to reduce Mod Conflicts
 
# [[Modding_Tutorials/Compatibility_with_DLLs|Mod DLL Compatibility]]
 
# [[Modding_Tutorials/Compatibility_with_DLLs|Mod DLL Compatibility]]
 
#* [[Modding_Tutorials/Injection|C# Injection]]
 
#* [[Modding_Tutorials/Injection|C# Injection]]
Line 56: Line 56:
 
==See also==
 
==See also==
  
* [[:Category:Defs|List of Defs]]
+
[[Category:Modding]]
 
 
 
[[Category:Modding tutorials]]
 
[[Category:Modding tutorials]]

Revision as of 04:54, 15 December 2017

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, this collection of tutorials has been written in hopes that more players will know how to modify RimWorld and make mods that further broaden horizons and make the game appealing to more audiences despite its early state.

Table of contents

Introduction

  1. First Steps and Some Links
  2. Essence of Modding
  3. Installing Mods
  4. Exploring the Folder Structure
  5. Mod Folder Structure
  6. 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. Decompiling Source Code
  3. Writing Custom Code
  4. Introduction to Def Classes
  5. Alter Code at Runtime with Harmony - this is a best practice, replacing C# code injection to reduce Mod Conflicts
  6. Mod DLL Compatibility
  7. Distribution

Examples:

See also