Difference between revisions of "Modding Tutorials"

From RimWorld Wiki
Jump to navigation Jump to search
(Start of major overhaul and cleanup)
Line 5: Line 5:
 
<hr>
 
<hr>
  
−
This is the hub page for tutorials, guides, and reference materials for creating mods for RimWorld. As RimWorld does not have a formal modding API, nearly all of the information here has been gathered and maintained by the modding community.
+
This is the hub page for tutorials, guides, and reference materials for creating mods for RimWorld. If you are looking for instructions on how to use RimWorld, please check out the general [[Modding]] hub.
  
−
'''NOTE''': (2023-06-12) As of the time of this writing, the modding section of the RimWorld Wiki is currently undergoing a major overhaul. New content is being written and older tutorials and guides are being revised or deleted. Please be patient while this overhaul takes place.
+
As RimWorld does not have a formal modding API, nearly all of the information here has been gathered and maintained by the modding community.
  
 
-----
 
-----
  
−
==What's a mod?==
+
==About RimWorld==
−
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]].
+
RimWorld is a multi-platform game written on Unity 2019.4. However, the Unity Editor is not used for creating mods unless you are creating new shaders.
  
−
==Introduction to modding==
+
* [[Modding_Tutorials/Recommended_software|Recommended Software]] - Editors and other useful software for mod development
−
# [[Modding Tutorials/First Steps|First Steps and Some Links]]
+
* [[Modding_Tutorials/Mod_Folder_Structure|Mod Folder Structure]] - Explore the basic folder structure of a mod
−
# [[Modding Tutorials/Essence| Essence of Modding]]
+
** [[Modding_Tutorials/About.xml|About.xml]] - About.xml identifies and describes your mod to RimWorld so that it can be loaded properly
−
# [[Modding Tutorials/Folder structure|Exploring the Folder Structure]]
+
* [[Modding_Tutorials/Defs|Defs]] - XML Definitions are used to define and configure content in a way that does not require compiling code
−
# [[Modding Tutorials/Mod folder structure|Mod Folder Structure]]
+
** [[Modding_Tutorials/MayRequire|MayRequire]] - MayRequire and MayRequireAnyOf are used to conditionally load Defs and list entries based on whether a DLC or other mod is loaded
−
#* [[Modding Tutorials/Mod folder structure#The About folder|About folder]]
+
* [[Modding_Tutorials/Localization|Localization]] - Define text strings used for translations and word lists used in name and text generation
−
#* [[Modding Tutorials/Mod folder structure#The Defs folder|Defs folder]]
+
* [[Modding_Tutorials/PatchOperations|PatchOperations]] - PatchOperations are used to modify XML Defs without overwriting them directly
−
#* [[Modding Tutorials/Mod folder structure#The Source and Assemblies folders|Assemblies folder]]
+
* [[Modding_Tutorials/Sounds|Sounds]] - (Needs Rewriting) Adding sound files for mods
−
#* [[Modding Tutorials/Mod folder structure#The Languages folder|Languages folder]]
+
* [[Modding_Tutorials/Textures|Textures]] - How to create and add textures to mods
−
#* [[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 Troubleshooting Tips and Guides]]
 
  
−
==General modding==
+
===XML Tutorials===
  
 +
The following are step-by-step tutorials for creating basic content mods.
 +
 +
Basic Tutorials:
 +
* [[Modding_Tutorials/Basic_Melee_Weapon|Basic Melee Weapon]] - How to create a basic melee weapon with a texture mask
 +
* [[Modding_Tutorials/Basic_Ranged_Weapon|Basic Ranged Weapon]] - How to create a basic ranged weapon with custom sound effects
 +
* [[Modding_Tutorials/Basic_Plant|Basic Plant]] - How to create a custom plant with both a cultivated and wild variant
 +
* Custom Animal (Upcoming)
 +
* Simple Building (Upcoming)
 +
* Custom Workbench (Upcoming)
 +
* Custom Drug (Upcoming)
 +
 +
Advanced Tutorials:
 +
* Custom Faction (Upcoming)
 +
* Custom Culture (Upcoming)
 +
* Custom Trader Type (Upcoming)
 +
 +
===C# Guides===
 +
 +
XML can be used to create and configure
 +
 +
* [[Modding_Tutorials/Decompiling source code|Decompiling Source Code]] - How to set up and use a decompiler to read vanilla game code
 +
* [[Modding_Tutorials/Setting up a solution|Setting up a Solution]] - How to set up a solution for compiling a custom mod assembly
 +
* [[Modding_Tutorials/Application_Startup|Application Startup]] - Describes the application startup process and the order in which game data is loaded
 +
* Custom Consumable (Upcoming)
 +
* Custom Overlays (Upcoming)
 +
 +
===Slightly Outdated===
 +
 +
* [[Modding_Tutorials/Plague_Gun_(1.1)|Plague Gun]] - This tutorial was created for RimWorld 1.0 but updated for 1.4. While the exact content is obsolete as you can now accomplish the same result with purely vanilla XML, it is still useful as a crash course for end-to-end mod creation and is here until newer tutorials can replace it.
 +
 +
===Uploading to Steam Workshop===
 +
* You can upload your mod to Steam Workshop by enabling Development Mode from your game Options and then using the Upload option under the Advanced button in the vanilla mod manager.
 +
* Note that in order to upload to Steam Workshop, you must own the game on Steam Workshop. Owning RimWorld on GOG or Epic will not work.
 +
* Your Preview.png should be a 640x360 or 1280x720 PNG and '''must''' be under 1MB. If it is too large, then your upload will be rejected with <code>Error : Limit Exceeded</code>
 +
* Steam mod descriptions don't use markdown, they use a variant of BBCode. Please check out the [https://steamcommunity.com/comment/Guide/formattinghelp Steam text formatting guide].
 +
 +
-----
 +
 +
'''Note:''' All of the above tutorials have been cleaned up and reviewed by the #mod-development team on the [https://discord.gg/rimworld RimWorld Discord] in cooperation with RimWorld Wiki staff editors. Please let us know before creating, adding, or making any major edits to the vetted tutorials and guides section!
 +
 +
==Outdated / Under Review==
 +
 +
The following tutorials are either out of date or in need of a rewrite. The information in them might be useful but may not be up to standard; please be aware of any potential inaccuracies until they can be addressed.
 +
 +
* [[Modding Tutorials/First Steps|First Steps and Some Links]]
 +
* [[Modding Tutorials/Essence| Essence of Modding]]
 +
* [[Modding Troubleshooting Tips and Guides]]
 
* [[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 36: Line 78:
 
* [[Modding Tutorials/Assets|Decompiling Texture/Sound Assets]]
 
* [[Modding Tutorials/Assets|Decompiling Texture/Sound Assets]]
 
* [[Modding Tutorials/Compatibility|Compatibility]]
 
* [[Modding Tutorials/Compatibility|Compatibility]]
−
* [[Modding_Tutorials/Distribution|Distribution]]</br>
+
* [[Modding_Tutorials/Distribution|Distribution]]
−
 
 
−
==Must-knows==
 
 
* [[Modding_Tutorials/Modifying defs|Modifying Defs]]
 
* [[Modding_Tutorials/Modifying defs|Modifying Defs]]
 
* [[Modding_Tutorials/Troubleshooting|Troubleshooting mods]]
 
* [[Modding_Tutorials/Troubleshooting|Troubleshooting mods]]
  
−
===Steam Workshop Specifics===
+
(Redundant, need to be reviewed and consolidated or removed)
−
* If you want to upload your mod to the Steam Workshop you must own the game on Steam. Owning it on Epic or GoG etc is not enough, both Steam and Tynan have confirmed this.
+
* [[Modding_Tutorials/Getting_started_with_mods|Getting Started With XML]]
−
* Your Preview.png must be under 1MB to upload to the Steam Workshop otherwise you will see ''"Error : Limit Exceeded"''
+
* [[Modding_Tutorials/Xml_Adding_Weapons_Traits_Research|Adding a New Weapon, Trait and Research to the game]]
−
* Steam mod descriptions don't use markdown, they use a form of BBCode. There is a [https://steamcommunity.com/comment/Guide/formattinghelp guide].
+
* [[Modding_Tutorials/Xml_Patches|Making Patches using Xml]]
−
 
 
−
==Updated guides==
 
−
These guides have been made with the most recent version of Rimworld in mind and are being updated to reflect changes in the game.
 
−
# [[Modding_Tutorials/Getting_started_with_mods|Getting Started With XML]]
 
−
# [[Modding_Tutorials/Xml_Adding_Weapons_Traits_Research|Adding a New Weapon, Trait and Research to the game]]
 
−
# [[Modding_Tutorials/Xml_Patches|Making Patches using Xml]]
 
  
−
==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/XML Defs|Introduction to XML Defs]]
−
#* [[Modding Tutorials/Compatibility with defs|XML Def Compatibility]]
+
** [[Modding Tutorials/Compatibility with defs|XML Def Compatibility]]
−
#* [https://7tsvn.github.io/RimWorld-AutoDocs Auto Documentation]
+
** [[Modding Tutorials/ThingDef|ThingDef explained]]
−
# In-depth XML Def tutorials
+
** [[Modding Tutorials/Weapons Guns|Weapons_Guns.xml explained]]. Slightly dated.
−
#* [[Modding Tutorials/ThingDef|ThingDef explained]]
 
−
#* [[Modding Tutorials/Weapons Guns|Weapons_Guns.xml explained]]. Slightly dated.
 
−
# [[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/Hello World|Hello World]]
−
# [[Modding_Tutorials/Hello World|Hello World]]
+
* [[Modding_Tutorials/Writing custom code|Writing Custom Code]]
−
# [[Modding_Tutorials/Decompiling source code|Decompiling Source Code]]
+
* [[Modding Tutorials/Linking XML and C#|Linking XML and C#]]
−
# [[Modding_Tutorials/Writing custom code|Writing Custom Code]]
+
* [[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/Linking XML and C#|Linking XML and C#]]
+
* [[Modding_Tutorials/Modifying classes|Adding fields and methods to classes]]
−
# [[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/ModSettings|Mod settings]] - Add settings to your mod
−
# The wonderful things you will want to do with C#
+
* [[Modding Tutorials/DefModExtension|Def mod extensions]] - Add (custom) fields to Defs
−
#* [[Modding_Tutorials/Modifying classes|Adding fields and methods to classes]]
+
* [[Modding Tutorials/Custom Comp Classes|Custom Comp Classes]] - A quick overview of what types of Comps there are, and what they're suited for.
−
# Useful things:
+
* [[Modding_Tutorials/ThingComp|ThingComp]] - Learn all there is to know about ThingComps.
−
#* [[Modding Tutorials/ModSettings|Mod settings]] - Add settings to your mod
+
* [[Modding Tutorials/GameComponent|Components]] - GameComponents, WorldComponents, and MapComponents
−
#* [[Modding Tutorials/DefModExtension|Def mod extensions]] - Add (custom) fields to Defs
+
* [[Modding_Tutorials/Def classes|Introduction to Def Classes]]
−
#* [[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/Compatibility_with_DLLs|Using Harmony to optionally patch other mods for the sake of compatibility]]
−
#** [[Modding_Tutorials/ThingComp|ThingComp]] - Learn all there is to know about ThingComps.
+
* [[Modding Tutorials/TweakValue|TweakValues]] - Change values on the fly (handy for quick iteration!)
−
#** [[Modding Tutorials/GameComponent|Components]] - GameComponents, WorldComponents, and MapComponents
+
* [[Modding Tutorials/ExposeData|ExposeData]] - Save stuff
−
#* [[Modding_Tutorials/Def classes|Introduction to Def Classes]]
+
* [[Modding Tutorials/BigAssListOfUsefulClasses|The big ass list of useful classes]] - A non-exhaustive list of classes you'll use most
−
#* [[Modding_Tutorials/Compatibility_with_DLLs|Using Harmony to optionally patch other mods for the sake of compatibility]]
+
* [[Modding Tutorials/GrammarResolver|Grammar Resolver]] - PAWN_objective, PAWN_possessive? Find out what it all means here.
−
#* [[Modding Tutorials/TweakValue|TweakValues]] - Change values on the fly (handy for quick iteration!)
+
* [https://github.com/Mehni/ExampleJob/wiki ExampleJob] - Mehni's top to bottom breakdown of Jobs.
−
#* [[Modding Tutorials/ExposeData|ExposeData]] - Save stuff
+
* [[Modding_Tutorials/ConfigErrors|Config Errors]] - Provide configuration issues to the user on startup.
−
#* [[Modding Tutorials/BigAssListOfUsefulClasses|The big ass list of useful classes]] - A non-exhaustive list of classes you'll use most
+
* [[Modding Tutorials/DebugActions|Debug Actions]] - Call methods from the debug menu
−
#* [[Modding Tutorials/GrammarResolver|Grammar Resolver]] - PAWN_objective, PAWN_possessive? Find out what it all means here.
+
* [https://www.arp242.net/rimworld-mod-linux.html Getting started with RimWorld modding on Linux]
−
#* [https://github.com/Mehni/ExampleJob/wiki ExampleJob] - Mehni's top to bottom breakdown of Jobs.
 
−
#* [[Modding_Tutorials/ConfigErrors|Config Errors]] - Provide configuration issues to the user on startup.
 
−
#* [[Modding Tutorials/DebugActions|Debug Actions]] - Call methods from the debug menu
 
−
# [https://www.arp242.net/rimworld-mod-linux.html Getting started with RimWorld modding on Linux]
 
  
−
==Art Tutorials==
+
===Art Tutorials===
 
* [https://spdskatr.github.io/RWModdingResources/artstyle Artstyle] - Officially unofficial guide to RimWorld's Artstyle
 
* [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://www.reddit.com/r/RimWorld/comments/5tn1pi/rimworldstyle_sprite_tutorials/ Ekksu's guide to creating RimWorld animals]
Line 96: Line 123:
 
* [https://github.com/seraphile/rimshare/wiki/Colouring-in-Images Seraphile's guide to masks]
 
* [https://github.com/seraphile/rimshare/wiki/Colouring-in-Images Seraphile's guide to masks]
  
−
== Under construction ==
+
===Under Construction===
−
These tutorials are under construction.
+
 
 +
These are currently unfinished and need to be cleaned up or removed
  
 
* [[Modding Tutorials/Quests]]
 
* [[Modding Tutorials/Quests]]
 
* [[Modding Tutorials/Troubleshooting/Finding Exceptions]]
 
* [[Modding Tutorials/Troubleshooting/Finding Exceptions]]
  
−
==Examples==
+
===Dangerously Outdated===
 +
 
 
* [[RimWorld 1.3: XML Mod Creation]]
 
* [[RimWorld 1.3: XML Mod Creation]]
 
* [[Modding Tutorials/Assembly Modding Example|Assembly Modding]]
 
* [[Modding Tutorials/Assembly Modding Example|Assembly Modding]]
Line 108: Line 137:
 
* [[Modding Tutorials/Xenotype template]] originally by Ryflamer
 
* [[Modding Tutorials/Xenotype template]] originally by Ryflamer
  
−
===Dangerously Outdated===
 
 
* [[Modding Tutorials/Smelter]]
 
* [[Modding Tutorials/Smelter]]
 
* [[Modding Tutorials/Items]]
 
* [[Modding Tutorials/Items]]
−
* [[Modding Tutorials/Weapons]]
 
 
* [[Modding Tutorials/Furniture]]
 
* [[Modding Tutorials/Furniture]]
−
* [[Plague Gun/Introduction|The Plague Gun]] based on the Plague Gun tutorial by Jecrell, updated for 1.0. {{LudeonThread|33219}}.
 
−
# [[Plague Gun/Required Items|Required Items]]
 
−
# [[Plague Gun/XML Stage|XML Stage]]
 
−
# [[Plague Gun/Connecting XML and Csharp|Connecting XML and C#]]
 
−
# [[Plague Gun/Csharp Assembly Setup|C# Assembly Setup]]
 
−
# [[Plague Gun/Csharp Coding|C# Coding]]
 
−
# [[Plague Gun/Localisation|Localisation]]
 
  
−
==See also==
+
==External Links==
 
* [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]

Revision as of 22:21, 10 February 2024

Basics Menus Game Creation Gameplay Pawns Plants Resources Gear Mods
Modding Modding Tutorials

This is the hub page for tutorials, guides, and reference materials for creating mods for RimWorld. If you are looking for instructions on how to use RimWorld, please check out the general Modding hub.

As RimWorld does not have a formal modding API, nearly all of the information here has been gathered and maintained by the modding community.

About RimWorld

RimWorld is a multi-platform game written on Unity 2019.4. However, the Unity Editor is not used for creating mods unless you are creating new shaders.

  • Recommended Software - Editors and other useful software for mod development
  • Mod Folder Structure - Explore the basic folder structure of a mod
    • About.xml - About.xml identifies and describes your mod to RimWorld so that it can be loaded properly
  • Defs - XML Definitions are used to define and configure content in a way that does not require compiling code
    • MayRequire - MayRequire and MayRequireAnyOf are used to conditionally load Defs and list entries based on whether a DLC or other mod is loaded
  • Localization - Define text strings used for translations and word lists used in name and text generation
  • PatchOperations - PatchOperations are used to modify XML Defs without overwriting them directly
  • Sounds - (Needs Rewriting) Adding sound files for mods
  • Textures - How to create and add textures to mods

XML Tutorials

The following are step-by-step tutorials for creating basic content mods.

Basic Tutorials:

  • Basic Melee Weapon - How to create a basic melee weapon with a texture mask
  • Basic Ranged Weapon - How to create a basic ranged weapon with custom sound effects
  • Basic Plant - How to create a custom plant with both a cultivated and wild variant
  • Custom Animal (Upcoming)
  • Simple Building (Upcoming)
  • Custom Workbench (Upcoming)
  • Custom Drug (Upcoming)

Advanced Tutorials:

  • Custom Faction (Upcoming)
  • Custom Culture (Upcoming)
  • Custom Trader Type (Upcoming)

C# Guides

XML can be used to create and configure

  • Decompiling Source Code - How to set up and use a decompiler to read vanilla game code
  • Setting up a Solution - How to set up a solution for compiling a custom mod assembly
  • Application Startup - Describes the application startup process and the order in which game data is loaded
  • Custom Consumable (Upcoming)
  • Custom Overlays (Upcoming)

Slightly Outdated

  • Plague Gun - This tutorial was created for RimWorld 1.0 but updated for 1.4. While the exact content is obsolete as you can now accomplish the same result with purely vanilla XML, it is still useful as a crash course for end-to-end mod creation and is here until newer tutorials can replace it.

Uploading to Steam Workshop

  • You can upload your mod to Steam Workshop by enabling Development Mode from your game Options and then using the Upload option under the Advanced button in the vanilla mod manager.
  • Note that in order to upload to Steam Workshop, you must own the game on Steam Workshop. Owning RimWorld on GOG or Epic will not work.
  • Your Preview.png should be a 640x360 or 1280x720 PNG and must be under 1MB. If it is too large, then your upload will be rejected with Error : Limit Exceeded
  • Steam mod descriptions don't use markdown, they use a variant of BBCode. Please check out the Steam text formatting guide.

Note: All of the above tutorials have been cleaned up and reviewed by the #mod-development team on the RimWorld Discord in cooperation with RimWorld Wiki staff editors. Please let us know before creating, adding, or making any major edits to the vetted tutorials and guides section!

Outdated / Under Review

The following tutorials are either out of date or in need of a rewrite. The information in them might be useful but may not be up to standard; please be aware of any potential inaccuracies until they can be addressed.

(Redundant, need to be reviewed and consolidated or removed)

XML tutorials

C# tutorials

Art Tutorials

Under Construction

These are currently unfinished and need to be cleaned up or removed

Dangerously Outdated

External Links

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