Difference between revisions of "Modding Tutorials"

From RimWorld Wiki
Jump to navigation Jump to search
Line 11: Line 11:
 
-----
 
-----
  
−
===What's a mod?===
+
==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]].
 
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===
+
==Introduction to modding==
 
# [[Modding Tutorials/First Steps|First Steps and Some Links]]
 
# [[Modding Tutorials/First Steps|First Steps and Some Links]]
 
# [[Modding Tutorials/Essence| Essence of Modding]]
 
# [[Modding Tutorials/Essence| Essence of Modding]]
Line 28: Line 28:
 
# [[Modding Tutorials/Recommended software|Recommended Software]]
 
# [[Modding Tutorials/Recommended software|Recommended Software]]
  
−
===General modding===
+
==General modding==
  
 
* [[Modding Tutorials/Testing mods|Testing Mods]]
 
* [[Modding Tutorials/Testing mods|Testing Mods]]
Line 39: Line 39:
 
* [[Modding_Tutorials/Modifying defs|Modifying Defs]]
 
* [[Modding_Tutorials/Modifying defs|Modifying Defs]]
  
−
 
+
==XML tutorials==
−
===XML tutorials===
 
  
 
# [[Modding Tutorials/XML file structure|XML File Structure]]
 
# [[Modding Tutorials/XML file structure|XML File Structure]]
Line 49: Line 48:
 
# [[Modding Tutorials/PatchOperations|PatchOperations]], replace specific xml elements of core files while keeping the rest untampered. Uses xpath.
 
# [[Modding Tutorials/PatchOperations|PatchOperations]], replace specific xml elements of core files while keeping the rest untampered. Uses xpath.
  
−
===C# tutorials===
+
==C# tutorials==
 
# [[Modding_Tutorials/Setting up a solution|Setting up]]
 
# [[Modding_Tutorials/Setting up a solution|Setting up]]
 
# [[Modding_Tutorials/Hello World|Hello World]]
 
# [[Modding_Tutorials/Hello World|Hello World]]
Line 70: Line 69:
 
#* [[Modding Tutorials/ExposeData|ExposeData]] - Save stuff
 
#* [[Modding Tutorials/ExposeData|ExposeData]] - Save stuff
 
#* [[Modding Tutorials/BigAssListOfUsefulClasses|The big ass list of useful classes]] - A non-exhaustive list of classes you'll use most
 
#* [[Modding Tutorials/BigAssListOfUsefulClasses|The big ass list of useful classes]] - A non-exhaustive list of classes you'll use most
 +
#* [https://github.com/Mehni/ExampleJob/wiki ExampleJob] - Mehni's top to bottom breakdown of Jobs.
 +
 +
==Art Tutorials==
 +
* [https://spdskatr.github.io/RWModdingResources/artstyle Artstyle] - Officially unofficial guide to RimWorld's Artstyle
 +
* [https://www.reddit.com/r/RimWorld/comments/5tn1pi/rimworldstyle_sprite_tutorials/ Ekksu's guide to creating RimWorld animals]
 +
* [https://steamcommunity.com/sharedfiles/filedetails/?id=1114369188 ChickenPlucker's guide to creating apparel]
 +
* [https://github.com/seraphile/rimshare/wiki/Colouring-in-Images Seraphile's guide to masks]
  
 
<br/><br/>
 
<br/><br/>

Revision as of 08:45, 8 February 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. PatchOperations, replace specific xml elements of core files while keeping the rest untampered. Uses xpath.

C# tutorials

  1. Setting up
  2. Hello World
  3. Decompiling Source Code
  4. Writing Custom Code
  5. Linking XML and C#
  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. The wonderful things you will want to do with C#
  8. Useful things:

Art Tutorials



Examples

  1. Required Items
  2. XML Stage
  3. Connecting XML and C#
  4. C# Assembly Setup
  5. C# Coding
  6. Localisation

Dangerously Outdated

See also

Retrieved from "https://rimworldwiki.com/index.php?title=Modding_Tutorials&oldid=62607"