Editing Modding Tutorials
Jump to navigation
Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 5: | Line 5: | ||
<hr> | <hr> | ||
| − | This is the | + | 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=== |
| + | # [[Modding Tutorials/First Steps|First Steps and Some Links]] | ||
| + | # [[Modding Tutorials/Essence| Essence of Modding]] | ||
| + | # [[Modding Tutorials/Folder structure|Exploring the Folder Structure]] | ||
| + | # [[Modding Tutorials/Mod folder structure|Mod Folder Structure]] | ||
| + | #* [[Modding Tutorials/Mod folder structure#The About folder|About folder]] | ||
| + | #* [[Modding Tutorials/Mod folder structure#The Defs folder|Defs folder]] | ||
| + | #* [[Modding Tutorials/Mod folder structure#The Source and Assemblies folders|Assemblies folder]] | ||
| + | #* [[Modding Tutorials/Mod folder structure#The Languages folder|Languages 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]] | ||
| − | + | ===General modding=== | |
| − | |||
| − | |||
| − | |||
* [[Modding Tutorials/Testing mods|Testing Mods]] | * [[Modding Tutorials/Testing mods|Testing Mods]] | ||
** [[Modding Tutorials/Testing mods#Development mode|Development Mode]] | ** [[Modding Tutorials/Testing mods#Development mode|Development Mode]] | ||
| Line 82: | Line 36: | ||
* [[Modding Tutorials/Compatibility|Compatibility]] | * [[Modding Tutorials/Compatibility|Compatibility]] | ||
* [[Modding_Tutorials/Distribution|Distribution]] | * [[Modding_Tutorials/Distribution|Distribution]] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===XML tutorials=== | ===XML tutorials=== | ||
| − | + | # [[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]] | |
| + | # (Added in Alpha 17) [[Modding Tutorials/PatchOperations|PatchOperations]], replace specific xml elements of core files while keeping the rest untampered | ||
===C# tutorials=== | ===C# tutorials=== | ||
| − | + | # [[Modding_Tutorials/Setting up a solution|Setting up]] | |
| − | + | # [[Modding_Tutorials/Hello World|Hello World]] | |
| − | * [[ | + | # [[Modding_Tutorials/Decompiling source code|Decompiling Source Code]] |
| − | + | # [[Modding_Tutorials/Writing custom code|Writing Custom Code]] | |
| − | * [[Modding_Tutorials/Modifying classes|Adding fields and methods to classes]] | + | # [[Modding_Tutorials/Def classes|Introduction to Def Classes]] |
| − | * [[Modding Tutorials/ModSettings|Mod settings]] - Add settings to your mod | + | #* [[Modding_Tutorials/Modifying defs|Def Class Compatibility]] |
| − | * [[Modding Tutorials/DefModExtension|Def mod extensions]] - Add (custom) fields to Defs | + | # [[Modding_Tutorials/Harmony | Alter Code at Runtime with Harmony]] - this is a best practice for modifying game code, replacing C# code injection to reduce Mod Conflicts |
| − | * [[Modding Tutorials/Custom Comp Classes|Custom Comp Classes]] - A quick overview of what types of Comps there are, and what they're suited for. | + | # The wonderful things you will want to do with C# |
| − | * [[Modding_Tutorials/ThingComp|ThingComp]] - Learn all there is to know about ThingComps. | + | #* [[Modding_Tutorials/Injection|C# Injection]] |
| − | * [[Modding Tutorials/GameComponent|Components]] - GameComponents, WorldComponents, and MapComponents | + | #* [[Modding_Tutorials/Modifying classes|Adding fields and methods to classes]] |
| − | + | # Useful things: | |
| − | * [[Modding_Tutorials/Compatibility_with_DLLs|Using Harmony to optionally patch other mods for the sake of compatibility]] | + | #* [[Modding Tutorials/ModSettings|Mod settings]] - Add settings to your mod |
| − | * [[Modding Tutorials/ | + | #* [[Modding Tutorials/DefModExtension|Def mod extensions]] - Add (custom) fields to Defs |
| − | * [[Modding Tutorials/ExposeData|ExposeData]] - Save stuff | + | #* [[Modding Tutorials/Custom Comp Classes|Custom Comp Classes]] - A quick overview of what types of Comps there are, and what they're suited for. |
| − | * [[Modding Tutorials/BigAssListOfUsefulClasses|The big ass list of useful classes]] - A non-exhaustive list of classes you'll use most | + | #** [[Modding_Tutorials/ThingComp|ThingComp]] - Learn all there is to know about ThingComps. |
| − | + | #** [[Modding Tutorials/GameComponent|Components]] - GameComponents, WorldComponents, and MapComponents | |
| − | + | #* [[Modding_Tutorials/Compatibility_with_DLLs|Using Harmony to optionally patch other mods for the sake of compatibility]] | |
| − | + | #* [[Modding Tutorials/TweakValues|TweakValues]] - Change values on the fly (handy for quick iteration!) | |
| − | + | #* [[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 | |
| − | + | <br/><br/> | |
| − | + | ''Examples:'' | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
* [[Modding Tutorials/Assembly Modding Example|Assembly Modding]] | * [[Modding Tutorials/Assembly Modding Example|Assembly Modding]] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | + | ==See also== |
* [https://github.com/roxxploxx/RimWorldModGuide/wiki Roxxploxx's set of modding tutorials] | * [https://github.com/roxxploxx/RimWorldModGuide/wiki Roxxploxx's set of modding tutorials] | ||
* [https://spdskatr.github.io/RWModdingResources/ RimWorld Modding Resources - A hub for guides, modders, practical tips] | * [https://spdskatr.github.io/RWModdingResources/ RimWorld Modding Resources - A hub for guides, modders, practical tips] | ||