RimWorld Wiki - User contributions [en]

Modding Tutorials/Setting up a solution

2023-05-18T02:10:45Z

Zeta18: /* Option 3 (Using Rimworld Dotnet Template): */ Fixed Link

{{BackToTutorials}}
{{Credit|[[User:Alistaire|Alistaire]]}} 

In this tutorial you will learn how to set up a solution, along with instructions on setting the output directory and files for more convenient building right into the Assemblies folder.

=Requirements=

* The manual option in this tutorial requires you to have [[Modding_Tutorials/Mod_folder_structure#The Source and Assemblies folders|set up a Source and Assemblies folder]] (the Visual Studio automatic option sets this up for you).
* You will want to have an IDE installed: [[Modding Tutorials/Recommended software#IDE's|Recommended IDE's]]. 

=Setting up a solution=
Setting up can be different for different IDE's. Feel free to add '''''complete''''' instructions for your IDE of choice.

===Visual Studio Community 2019===
''NOTE: Visual Studio 2019 is a rather heavy application (2-3 GB for basic functionality) but has a bit more functionality. Only Install if your computer can handle it! This tutorial is similar for other versions of Visual Studio.''

==== Option 1 (Manual Method):====
# Create a new class library project
## Once loaded, go to File -> New -> Project...
## Type "Class Library (.NET Framework)" in the search bar, and select the C# option. [[File:ClassLibrary.png|200px|thumb|right|Installing the .NET framework]]
## Enter your project name.
## Choose a location, preferably: <pre>(RimWorldInstallFolder)/Mods/(YourModName)/Source</pre>
## Enter a solution name (optionally, tick "Place solution and project in the same directory")
## Make sure Framework is ".NET Framework 4.7.2"
# In your project, set target framework and various other properties
## In your Solution Explorer (the panel usually located on the right), right click your project -> Properties (or expand your project and double click "Properties" with the wrench icon)
## ''Optional'': Under Application, change your Assembly and Namespace names to anything of your choice
## Go to Build -> Advanced... and set "Debugging information" to none
## Leave Advanced..., and set the Output Path to "..\..\Assemblies\" (Or wherever the Assemblies folder is)
# Add references to RimWorld code
## Expand your project in Solution Explorer. Then right click "References" -> Add Reference...
## Click Browse...
## Navigate towards <pre>RimWorldInstallPath/RimWorld******_Data/Managed</pre> and select files: <pre>Assembly-CSharp.dll
UnityEngine.CoreModule.dll</pre>
## Click "Add"
## Click "OK" to close the Reference Manager.
## Right-click on both Assembly-CSharp.dll and UnityEngine.dll and set Copy Local to False (Properties pane).

====Option 2 (Using Nuget):====
This option uses [https://www.nuget.org/packages/Krafs.Rimworld.Ref Krafs Rimworld Reference Package] it is less involved than using reference assemblies and is the recommended method.
#Follow the above up till ''Add references to RimWorld code''
#Open Nuget Manager and type ''Rimworld''
#Add Krafs Rimworld Reference
#When prompted '''Select packagereference''' (this is required for the package to be added)
You can now continue as if you added the assemblies
Doing this makes your project portable, because RimRef can be downloaded by anyone and used from anywhere, unlike Rimworld's assemblies which can't be distributed.

====Option 3 (Using Rimworld Dotnet Template):====
This option uses [https://github.com/Zeta-of-the-rim/Rimwold-Dotnet-Template Rimworld Dotnet Template] it allows faster creation of mod files including Xml folders

After installing the template.
#Open your mod folder
#create a new folder for your mod (It is best to use the name you want for your mod)
#Open a command prompt in that folder
#type ''dotnet new RimMod'' (This will create a new mod with the name you specified)
#Open the About folder and edit the About.xml file
#Open the .sln file in your preferred IDE
#Add the rimworld assemblies using your preferred method

While this method is faster, it is still good to know how to do it manually.

====Option 4 (Using Cookiecutter):====
This option uses the [https://ludeon.com/forums/index.php?topic=39038.0 Rimworld Mod Development Cookiecutter] tool.
'''Note: despite being automatic and potentially taking away some of the tedium away, the environment it sets up is very particular and this tool is currently not recommended for newcomers.'''
''As of Jan 2019, the cookiecutter is set up for Windows development. Linux/Mac people can still use it, but they will have a few errors to clean up.''
# Open Visual Studio
# Once loaded, go to File -> New -> From Cookiecutter...
# Search for ''rimworld''
# Double-click ''cookiecutter-rimworld-mod-development''
# Change the Template Options:
## ''Create To'' => ''Your/Rimworld/Mod/Directory''
## ''mod_name''
## ''namespace_name'' (don't change if unsure)
## ''author'' => ''your steam username''
## ''target_version'' => current RW version (can leave blank for most up-to-date)
## ''in_game_description'' (not required, can change later in About-Release.xml)
## ''url'' (can leave blank for link to your Steam Workshop profile)
# Click "Create and Open Folder"

===Sharpdevelop===
'''Caution:''' Sharpdevelop (or #develop) does NOT CURRENTLY allow for C# 6.0+ syntax without plugins and does NOT ALLOW for C# 7.0+ syntax at all. For your average project this does not matter, however some existing projects are already built entirely upon C# 6.0+ syntax which can not be compiled anymore in Sharpdevelop. Visual Studio does not have these issues and should be your go-to for compiling large projects such as Combat Extended.

# Create a new class library project in your [[Modding Tutorials/Recommended software#IDE.27s|IDE of choice]];
## Go to File -> New -> Solution;
## Go to C# or .NET -> Library or Class Library (NOT portable);
## Enter a project name (solution name automatically updated);
## Choose a location, preferably: <pre>(RimWorldInstallFolder)/Mods/(YourModName)/Source</pre>
## ''Optional'': Untick "Create a directory for solution"/"Create a project within the solution directory",
# In your project, add references to Assembly-CSharp.dll and UnityEngine.dll:
## In your IDE project file browser, right-click the "References" folder and "Add reference";
## Choose the ".NET Assembly Browser" tab and "Browse...";
## Navigate towards <pre>RimWorld******/RimWorld******_Data/Managed</pre> and select files: <pre>Assembly-CSharp.dll
UnityEngine.CoreModule.dll</pre>
## Click "Open" then "OK";
## In the References folder, right-click Assembly-CSharp -> Properties and change "Local copy" to False. Do the same for UnityEngine,
# In your project properties, change the target framework to .NET 4.7.2:
## In your IDE project file browser, right-click "(YourSolutionName)";
## Choose Properties;
## Go to the "Compiling" tab, "Output", "Target framework", "Change" and choose ".NET Framework 4.7.2",
# In your project properties, change the build events so only a single file is built:
## Go to the "Compiling" tab, "Output", "Debug info" and choose "No debug information";
## Right-click your .cs files -> Properties and change "Copy to output" (If you haven't resized the properties bar, this will be truncated to "Copy to out") to Never,
# In your project properties, fix the output location to put the DLL in the Assemblies folder:
## Go to the "Compiling" tab, "Output", "Output path" and change the output path to "..\..\Assemblies\". 

===Xamarin/MonoDevelop===
The setup is similar as the one above. A few special points to address:
# Mono 4.X isn't backward compatible so you may need to install an older 3.X version of Mono in order to compile against .NET4.7.2 dlls.
# Make sure you uncheck "Use MSBuild build engine (recommended for this project type)" under project > options > build > general (You might find this by right-clicking on your project - not solution - name and selecting options)
# Changing the framework to 4.7.2 can be found (for Linux anyway) in the same place.

More detailed installation instructions for Linux can be found [https://blog.rubenwardy.com/2016/07/21/rimworld-setup-monodevelop/ here] and [https://spdskatr.github.io/RWModdingResources/mono-arch here]. Note that as of now (2021) these may be outdated, so if it doesn't work, you can try the steps described in the Mono section.

===Mono===
On Linux and Mac(?) it is possible to use Mono regardless of IDE (from command line, or if your IDE/editor has build support).
# Install Mono (refer to your distribution's instructions);
# To build using .csproj files that other setups use, you need the ''dotnet'' tool, you can get it by installing the [https://dotnet.microsoft.com/download .NET SDK];
# If you're starting a new mod and want to use a .csproj file for compatibility with other modders, find e.g. a mod that has description pointing to its GitHub sources and copy from there;
# For building use a command like the following (substitute the proper .csproj file and 4.7.2 is the .NET version from the .csproj file): <pre>FrameworkPathOverride=$(dirname $(which mono))/../lib/mono/4.7.2-api/ dotnet build <project file>.csproj /property:Configuration=Release</pre>
# If you get errors, it is necessary to edit the .csproj file:
## You may need to fix paths (point them to .dll files in RimWorld/RimWorld*_Data/Managed);
## See other setups above for other settings (those IDEs write those settings to the .csproj files);

===Rider (good for Mac)===
JetBrains Rider is a great cross-platform C# IDE, but it isn't cheap. It's $140 for the first year, including perpetual access to that version (access to future updates gets cheaper, but it's still over $100/year). However, the Early Access versions are a bit unstable but free. They also offer free student licenses.

# Open Rider and click New Solution in the welcome dialog.
## Click Class Library under .NET on the left. The option may a second to show up.
## Under Solution Name (and Project Name), enter the name of your mod.
## Set the Solution Directory to [your mod folder]/Source.
## Optionally check "put solution and project in the same directory." This is probably a good idea.
## Change Framework to .Net Framework 4.7.2.
## Click Create.
# In the left side bar, expand your solution, right click your project (mod name with "C#" icon) and click Properties.
## In the Properties window, select Configurations > Debug on the left and uncheck Debug Symbols.
## For both configurations, change the Output Path to ../../Assemblies.
## Click OK.
# Expand your project, right click References and click Add Reference.
## Click Add From.
## Browse to the folder with the RimWorld DLLs (Mac: /Users/[username]/Library/Application Support/Steam/steamapps/common/RimWorld/RimWorldMac.app/Contents/Resources/Data/Managed).
## Select both Assembly-CSharp.dll and UnityEngine.dll and click OK.
## Expand Assemblies under References. For both of the assemblies that you just added:
### Right click the assembly and click Properties.
### Uncheck "Copy Local" (you may need to scroll down) and click OK.

You're done! Note that Rider has a built-in decompiler—to view the source of a RimWorld class or method, just right-click its name and click Go To > Definition.

=Common issues=
* Can't find the option to target .NET Framework 4.7.2? It may require additional installation steps. In Visual Studio, Tools => Get Tools and features => Individual Components => Select ''.NET Framework 4.7.2 development tools'' (or google installation instructions). Also make sure your project is a ''Class Library (.NET '''Framework''')''. Not .NET Core or .NET Standard.

=See also=
* [[Modding Tutorials/Writing custom code|Writing custom code]] continues on setting up your solution. 

[[Category:Modding tutorials]]

Blood rot

2023-05-05T11:08:22Z

Zeta18: /* Treatment */ added healer mech serum

{{Royalty}}
__NOTOC__
'''Blood rot''' is a long-lasting [[disease]] that can be fatal if untreated.

Unlike other diseases, it doesn't appear on its own, but rather only appears as part of quests if you have the [[Royalty DLC]] installed.

== Stages ==
These are the following stages in which blood rot will progress through, and the effects it has on the victim:

{| class="wikitable"
|-
! Stage !! Begins at !! Symptoms
|-
| '''Blood rot (minor)''' || 0 - 0.59 severity ||
*-5% [[Blood pumping]]
*-5% [[Blood filtration]]
|-
| '''Blood rot (major)''' || 0.6 - 0.84 severity ||
*-10% Blood pumping
*-10% Blood filtration
*Vomiting on average every 1.5 days
|-
| '''Blood rot (Extreme)''' || 0.85 - 0.99 severity ||
*+5% [[Pain]]
*-15% Blood pumping
*-15% Blood filtration
*Vomiting on average every 0.75 days
|-
| '''Blood rot (Extreme)''' || 1.00 severity ||
*Death
|}

=== Progression ===
*Severity increases by 0.4 per day.
*Treatment slows progression by a maximum of 1 per day.
**This means the disease will regress by 0.6 per day at 100% tend quality.
**Progression will stop at 40% tend quality or higher.
**Note that good treatment will not cause the disease to go away on its own.

The disease resolves after 30-40 days, independent of the patient's immune functioning.

== Treatment ==
Treatment can be done using medicine which suppresses the disease, preventing it from reaching fatal stages. Pawns do not need to rest, as no immunity is gained.

A tend quality of 40% or higher is required to prevent the disease from progressing at all. With a good enough doctor, high quality [[hospital bed]], and a well-lit [[sterile tile|sterile room]], it is possible to reach average 40% tend quality even without medicine. [[Herbal medicine]] can be used if you don't have a good hospital setup yet, or if you need to reverse existing progression.

An immediate cure is expensive, requiring 10 [[glitterworld medicine]] and a doctor with medical skill 5 or above, or a [[healer mech serum]].

== Version history ==
* 1.1 - Added at some point in 1.1.
* [[Version/1.1.2654|1.1.2654]] - Disease removed from the basegame and added to the Royalty DLC. Previously it was fully functional in Core, but did not appear in regular, unmodded gameplay unless Royalty was enabled. Reduce blood rot severity per day gain from 60% to 40%.
{{Nav/disease}}
[[Category:Disease]]

Modding Tutorials

2023-04-21T04:50:04Z

Zeta18: /* Updated guides */ Added guide

{| align=center
| {{Mods_Nav}}
|}
<hr>

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. While most of this wiki was updated for 1.0, 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]]
# [[Modding Troubleshooting Tips and Guides]]

==General modding==

* [[Modding Tutorials/Testing mods|Testing Mods]]
** [[Modding Tutorials/Testing mods#Development mode|Development Mode]]
* [[Modding Tutorials/Sounds|Adding and Testing Sounds]]
* [[Modding Tutorials/Assets|Decompiling Texture/Sound Assets]]
* [[Modding Tutorials/Compatibility|Compatibility]]
* [[Modding_Tutorials/Distribution|Distribution]]

==Must-knows==
* [[Modding_Tutorials/Modifying defs|Modifying Defs]]
* [[Modding_Tutorials/Troubleshooting|Troubleshooting mods]]

===Steam Workshop Specifics===
* 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.
* Your Preview.png must be under 1MB to upload to the Steam Workshop otherwise you will see ''"Error : Limit Exceeded"''
* Steam mod descriptions don't use markdown, they use a form of BBCode. There is a [https://steamcommunity.com/comment/Guide/formattinghelp guide].

==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/Geting_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==

# [[Modding Tutorials/XML file structure|XML File Structure]]
# [[Modding Tutorials/XML Defs|Introduction to XML Defs]]
#* [[Modding Tutorials/Compatibility with defs|XML Def Compatibility]]
#* [https://7tsvn.github.io/RimWorld-AutoDocs Auto Documentation]
# In-depth XML Def tutorials
#* [[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==
# [[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/Linking XML and C#|Linking XML and C#]]
# [[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
# The wonderful things you will want to do with C#
#* [[Modding_Tutorials/Modifying classes|Adding fields and methods to classes]]
# Useful things:
#* [[Modding Tutorials/ModSettings|Mod settings]] - Add settings to your mod
#* [[Modding Tutorials/DefModExtension|Def mod extensions]] - Add (custom) fields to Defs
#* [[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/ThingComp|ThingComp]] - Learn all there is to know about ThingComps.
#** [[Modding Tutorials/GameComponent|Components]] - GameComponents, WorldComponents, and MapComponents
#* [[Modding_Tutorials/Def classes|Introduction to Def Classes]]
#* [[Modding_Tutorials/Compatibility_with_DLLs|Using Harmony to optionally patch other mods for the sake of compatibility]]
#* [[Modding Tutorials/TweakValue|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
#* [[Modding Tutorials/GrammarResolver|Grammar Resolver]] - PAWN_objective, PAWN_possessive? Find out what it all means here.
#* [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==
* [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]

== Under construction ==
These tutorials are under construction.

* [[Modding Tutorials/Quests]] - Creator: [[User:NightmareCorporation]]
* [[Modding Tutorials/Troubleshooting/Finding Exceptions]] - Creator: [[User:NightmareCorporation]]

==Examples==
* [[RimWorld 1.3: XML Mod Creation]]
* [[Modding Tutorials/Assembly Modding Example|Assembly Modding]]
* [[Plague Gun (1.1)|The Plague Gun]] tutorial originally by Jecrell, updated to 1.1+.
* [[Modding Tutorials/Xenotype template]] originally by Ryflamer

===Dangerously Outdated===
* [[Modding Tutorials/Smelter]]
* [[Modding Tutorials/Items]]
* [[Modding Tutorials/Weapons]]
* [[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==
* [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]

[[Category:Modding]]
[[Category:Modding tutorials]]

File:CustomTrait.png

2023-04-14T01:42:20Z

Zeta18: Image of a custom trait added using Xml.

== Summary ==
Image of a custom trait added using Xml.
== Licensing ==
{{Copyright nolicense}}

Modding Tutorials

2023-04-13T22:34:42Z

Zeta18: Linked new tutorial

{| align=center
| {{Mods_Nav}}
|}
<hr>

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. While most of this wiki was updated for 1.0, 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]]
# [[Modding Troubleshooting Tips and Guides]]

==General modding==

* [[Modding Tutorials/Testing mods|Testing Mods]]
** [[Modding Tutorials/Testing mods#Development mode|Development Mode]]
* [[Modding Tutorials/Sounds|Adding and Testing Sounds]]
* [[Modding Tutorials/Assets|Decompiling Texture/Sound Assets]]
* [[Modding Tutorials/Compatibility|Compatibility]]
* [[Modding_Tutorials/Distribution|Distribution]]

==Must-knows==
* [[Modding_Tutorials/Modifying defs|Modifying Defs]]
* [[Modding_Tutorials/Troubleshooting|Troubleshooting mods]]

===Steam Workshop Specifics===
* 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.
* Your Preview.png must be under 1MB to upload to the Steam Workshop otherwise you will see ''"Error : Limit Exceeded"''
* Steam mod descriptions don't use markdown, they use a form of BBCode. There is a [https://steamcommunity.com/comment/Guide/formattinghelp guide].

==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/Geting_started_with_mods|Getting Started With XML]]
# [[Modding_Tutorials/Xml_Adding_Weapons_Traits_Research|Adding a New Weapon, Trait and Research to the game]]

==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]]
#* [https://7tsvn.github.io/RimWorld-AutoDocs Auto Documentation]
# In-depth XML Def tutorials
#* [[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==
# [[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/Linking XML and C#|Linking XML and C#]]
# [[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
# The wonderful things you will want to do with C#
#* [[Modding_Tutorials/Modifying classes|Adding fields and methods to classes]]
# Useful things:
#* [[Modding Tutorials/ModSettings|Mod settings]] - Add settings to your mod
#* [[Modding Tutorials/DefModExtension|Def mod extensions]] - Add (custom) fields to Defs
#* [[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/ThingComp|ThingComp]] - Learn all there is to know about ThingComps.
#** [[Modding Tutorials/GameComponent|Components]] - GameComponents, WorldComponents, and MapComponents
#* [[Modding_Tutorials/Def classes|Introduction to Def Classes]]
#* [[Modding_Tutorials/Compatibility_with_DLLs|Using Harmony to optionally patch other mods for the sake of compatibility]]
#* [[Modding Tutorials/TweakValue|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
#* [[Modding Tutorials/GrammarResolver|Grammar Resolver]] - PAWN_objective, PAWN_possessive? Find out what it all means here.
#* [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==
* [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]

== Under construction ==
These tutorials are under construction.

* [[Modding Tutorials/Quests]] - Creator: [[User:NightmareCorporation]]
* [[Modding Tutorials/Troubleshooting/Finding Exceptions]] - Creator: [[User:NightmareCorporation]]

==Examples==
* [[RimWorld 1.3: XML Mod Creation]]
* [[Modding Tutorials/Assembly Modding Example|Assembly Modding]]
* [[Plague Gun (1.1)|The Plague Gun]] tutorial originally by Jecrell, updated to 1.1+.
* [[Modding Tutorials/Xenotype template]] originally by Ryflamer

===Dangerously Outdated===
* [[Modding Tutorials/Smelter]]
* [[Modding Tutorials/Items]]
* [[Modding Tutorials/Weapons]]
* [[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==
* [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]

[[Category:Modding]]
[[Category:Modding tutorials]]

Modding Tutorials

2023-04-12T08:38:55Z

Zeta18: Added section linking new guides the this page

{| align=center
| {{Mods_Nav}}
|}
<hr>

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. While most of this wiki was updated for 1.0, 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]]
# [[Modding Troubleshooting Tips and Guides]]

==General modding==

* [[Modding Tutorials/Testing mods|Testing Mods]]
** [[Modding Tutorials/Testing mods#Development mode|Development Mode]]
* [[Modding Tutorials/Sounds|Adding and Testing Sounds]]
* [[Modding Tutorials/Assets|Decompiling Texture/Sound Assets]]
* [[Modding Tutorials/Compatibility|Compatibility]]
* [[Modding_Tutorials/Distribution|Distribution]]

==Must-knows==
* [[Modding_Tutorials/Modifying defs|Modifying Defs]]
* [[Modding_Tutorials/Troubleshooting|Troubleshooting mods]]

===Steam Workshop Specifics===
* 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.
* Your Preview.png must be under 1MB to upload to the Steam Workshop otherwise you will see ''"Error : Limit Exceeded"''
* Steam mod descriptions don't use markdown, they use a form of BBCode. There is a [https://steamcommunity.com/comment/Guide/formattinghelp guide].

==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/Geting_started_with_mods|Getting Started With XML]]

==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]]
#* [https://7tsvn.github.io/RimWorld-AutoDocs Auto Documentation]
# In-depth XML Def tutorials
#* [[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==
# [[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/Linking XML and C#|Linking XML and C#]]
# [[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
# The wonderful things you will want to do with C#
#* [[Modding_Tutorials/Modifying classes|Adding fields and methods to classes]]
# Useful things:
#* [[Modding Tutorials/ModSettings|Mod settings]] - Add settings to your mod
#* [[Modding Tutorials/DefModExtension|Def mod extensions]] - Add (custom) fields to Defs
#* [[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/ThingComp|ThingComp]] - Learn all there is to know about ThingComps.
#** [[Modding Tutorials/GameComponent|Components]] - GameComponents, WorldComponents, and MapComponents
#* [[Modding_Tutorials/Def classes|Introduction to Def Classes]]
#* [[Modding_Tutorials/Compatibility_with_DLLs|Using Harmony to optionally patch other mods for the sake of compatibility]]
#* [[Modding Tutorials/TweakValue|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
#* [[Modding Tutorials/GrammarResolver|Grammar Resolver]] - PAWN_objective, PAWN_possessive? Find out what it all means here.
#* [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==
* [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]

== Under construction ==
These tutorials are under construction.

* [[Modding Tutorials/Quests]] - Creator: [[User:NightmareCorporation]]
* [[Modding Tutorials/Troubleshooting/Finding Exceptions]] - Creator: [[User:NightmareCorporation]]

==Examples==
* [[RimWorld 1.3: XML Mod Creation]]
* [[Modding Tutorials/Assembly Modding Example|Assembly Modding]]
* [[Plague Gun (1.1)|The Plague Gun]] tutorial originally by Jecrell, updated to 1.1+.
* [[Modding Tutorials/Xenotype template]] originally by Ryflamer

===Dangerously Outdated===
* [[Modding Tutorials/Smelter]]
* [[Modding Tutorials/Items]]
* [[Modding Tutorials/Weapons]]
* [[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==
* [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]

[[Category:Modding]]
[[Category:Modding tutorials]]

File:Empty item.png

2023-04-12T07:36:15Z

Zeta18: A screenshot of a basic item with no textures for a mod guide

== Summary ==

A screenshot of a basic item with no textures for a mod guide
== Licensing ==
{{Copyright nolicense}}

File:Adding Textures.png

2023-04-12T07:33:59Z

Zeta18: A screenshot of a mod item with textures added

== Summary ==
A screenshot of a mod item with textures added
== Licensing ==
{{Copyright nolicense}}

Modding Tutorials/Recommended software

2023-04-06T01:19:37Z

Zeta18: Added section on dotPeek

{{BackToTutorials}}
 

=What you'll learn=

This tutorial lists a few programs you could use to edit XML and C# code. 

=XML Code Editors=

===Basic Editors===

Just about any text editor can write XML code, but some are better suited than others. Rich text editors (WordPad, anything part of any Office suite) should be avoided. Windows' simple notepad will work, but you'll want something which offers things like "Find in Files" functionality and syntax highlighting. If you're even somewhat serious about modding, the following software will help you immensely: 

{| class="wikitable"
! Software !! OS !! Description
|-
| [https://notepadqq.com/s/ NotepadQQ] || Linux || Notepadqq is a Notepad++-like editor for the Linux desktop so has the exact same UI and functions as Notepad++
|-
| [http://notepad-plus-plus.org/download/ Notepad++] || Windows || Light-weight editor with extension support.
|-
| [http://www.sublimetext.com/ Sublime Text] || Linux/Windows/Mac || Natively supports many programming languages and markup languages, and its functionality can be extended by users with plugins - A brief overview of its functionality can be found [http://webdesign.tutsplus.com/tutorials/useful-shortcuts-for-a-faster-workflow-in-sublime-text-3--cms-22185 here] and a full course [http://code.tutsplus.com/courses/perfect-workflow-in-sublime-text-2 here]
|-
| [https://atom.io/ Atom] || Linux/Windows/Mac || A hackable electron-based text editor with emphasis on extensions and GitHub collaboration.
|-
| [https://code.visualstudio.com/ Visual Studio Code] || Linux/Windows/Mac || A text editor with emphasis on productivity and extension support.
|-
| [http://xmlnotepad.codeplex.com/releases/ XML Notepad] || Windows || XML-oriented editor with a lot of features you will most likely never use in Rimworld modding
|-
| [http://www.geany.org/ Geany] || Linux/Windows/Mac || Extremely lightweight text editor with syntax highlighting and some other basic features oriented towards XML and code editing.
|} 

===Advanced Editors===

There's many editors out there specifically made for XML code. Because Rimworld uses XML in a very simple way, advanced code editors are rarely needed. In case you're ever in need of one, however, the following ones might help: 

{| class="wikitable"
! Software !! OS !! Description
|-
| [http://sourceforge.net/projects/xpontus/files/ XPontus] || Windows || Has a tree view and is capable of checking XML for errors, fixing tabs and creating schema's detailing every tag's data types
|-
| [http://xmlgrid.net/ XMLGrid] || - || Capable of validating XML and turning it into Excel Spreadsheets, XSD Charts and an online table detailing each tag of a certain type and its contents
|-
| [http://codebeautify.org/xmlviewer Codebeautify's xmlviewer] || - || Can display as a tree view, automatically format/indent your code and can validate and show errors too. Also have a function share code (like [http://codebeautify.org/xmlviewer/b39586 that])
|} 
An alternative to "Advanced editors" are plugins/extensions. Good extensions can highlight syntax (if not already standard), format XML, find xpath, auto-close XML tags, supports renaming tags, and more.
 

=IDEs=

C# code is best edited in an IDE (Integrated Development Environment) to make the process of editing code, managing a solution's content and compiling its projects both easier and faster. Any IDE for C# will probably work just fine, so here's a list of suggested editors: 

{| class="wikitable"
! Software !! OS !! Description
|-
| [http://www.visualstudio.com/ Visual Studio] || Windows/Mac || Very extensive IDE with paid, trial and free versions. Any of these versions will probably work, so you might as well take [https://www.visualstudio.com/products/visual-studio-community-vs Visual Studio Community] which is free for individuals and small teams. Always the most up-to-date
|-
| [http://www.icsharpcode.net/OpenSource/SD/Download/ SharpDevelop] || Windows || Free IDE specifically made for C#
|-
| [http://www.monodevelop.com/download/ MonoDevelop] || Linux/Windows/Mac || Free, cross-platform IDE with customizable user interface. Has support for C# as well as some other languages you won't need for Rimworld
|-
| [https://www.xamarin.com/platform Xamarin] || Windows/Mac ||It's free but you need to register to download it. Xamarin is an open-source platform for building modern and performant applications for iOS, Android, and Windows with .NET. Avaliable as an extension to Visual studio 2022 and 2019
|-
| [https://www.jetbrains.com/rider/ Rider] || Windows/Mac/Linux|| Unless you're a student it costs, but offers a lot of tools across all platforms.
|}

Whichever IDE you choose, make sure it's capable of compiling for .NET Framework 4.7.2. If you for whatever reason don't have this framework installed, you can download it [https://dotnet.microsoft.com/download/dotnet-framework/net472 here]. 

=Additional C# Software=

Besides your IDE it's strongly recommended to install the following software for decompiling: 

{| class="wikitable"
! Software !! OS !! Description
|-
| [https://github.com/0xd4d/dnSpy dnSpy] || Windows || Software which is capable of [[Modding Tutorials/Decompiling source code|decompiling source code]], which is very useful in Rimworld modding (some authors have had better luck with dnSpy than ILSpy?)
|-
| [http://ilspy.net/ ILSpy] || Windows/Linux/Mac || Software which is capable of [[Modding Tutorials/Decompiling source code|decompiling source code]], which is very useful in Rimworld modding
|-
| [http://www.monodevelop.com/download/ MonoDevelop] || Linux/Windows/Mac || The Linux version of the software has an integrated decompiler for .DLLs
|-
| [https://www.jetbrains.com/decompiler/ dotPeek] || Windows || A C# decompiler for .DLLs it slow to open but has great functionality
|} 

=Graphics Software=

For making textures you will need graphics software. Any image editing program should work, and if you have an alternative to the following links that's probably okay: 

{| class="wikitable"
! Software !! OS !! Description
|-
| [http://www.photofiltre-studio.com/download-en.htm Photofiltre Studio] || Windows || Functional software with very little user interface clutter for its applications. Doesn't support pen tablet, and has a 100% free (non-trial) version called [http://photofiltre.free.fr/download_en.htm Photofiltre]
|-
| [http://inkscape.org/en/download/ Inkscape] || Linux/Windows/Mac || Free vector graphic program with a steeper learning curve due to the vector based image editing. Vector graphics can look better than bitmap graphics in Rimworld
|-
| [http://www.photoshop.com/products Photoshop] || Windows/Mac || Paid software with a trial version. Rimworld's original graphics are made in Photoshop (they're .PSD files)
|-
| [http://www.gimp.org/ GIMP] || Linux/Windows/Mac || A free, open-source alternative to Photoshop that's been around since 1998. GIMP has a large user community, with great list of [http://www.gimp.org/tutorials/ tutorials] on the official sites
|-
| [https://krita.org/en/homepage/ Krita] || Linux/Windows/Mac || A free digital painting software. Better suited than GIMP for painting and should feel like home pretty quick for Photoshop users.
|} 

=Audio Software=

Recording your own audio for mods might be too much to ask, but editing audio is always possible. This can be done with the following software or your own alternative: 

{| class="wikitable"
! Software !! OS !! Description
|-
| [http://sourceforge.net/projects/audacity/ Audacity] || Linux/Windows/Mac || Audio editing software with many tutorials online, lots of useful functionality and a relatively readable interface
|} 

=Next up=

# [[Modding Tutorials/XML file structure|XML File Structure]] starts you off with the XML side of modding.
# [[Modding_Tutorials/Setting up a solution|Setting up]] starts you off with the C# side of modding. Knowledge of the XML part can and will be very useful. 

[[Category:Modding tutorials]]

Modding Tutorials/Setting up a solution

2023-04-05T05:11:40Z

Zeta18: Fixed formating

{{BackToTutorials}}
{{Credit|[[User:Alistaire|Alistaire]]}} 

In this tutorial you will learn how to set up a solution, along with instructions on setting the output directory and files for more convenient building right into the Assemblies folder.

=Requirements=

* The manual option in this tutorial requires you to have [[Modding_Tutorials/Mod_folder_structure#The Source and Assemblies folders|set up a Source and Assemblies folder]] (the Visual Studio automatic option sets this up for you).
* You will want to have an IDE installed: [[Modding Tutorials/Recommended software#IDE's|Recommended IDE's]]. 

=Setting up a solution=
Setting up can be different for different IDE's. Feel free to add '''''complete''''' instructions for your IDE of choice.

===Visual Studio Community 2019===
''NOTE: Visual Studio 2019 is a rather heavy application (2-3 GB for basic functionality) but has a bit more functionality. Only Install if your computer can handle it! This tutorial is similar for other versions of Visual Studio.''

==== Option 1 (Manual Method):====
# Create a new class library project
## Once loaded, go to File -> New -> Project...
## Type "Class Library (.NET Framework)" in the search bar, and select the C# option. [[File:ClassLibrary.png|200px|thumb|right|Installing the .NET framework]]
## Enter your project name.
## Choose a location, preferably: <pre>(RimWorldInstallFolder)/Mods/(YourModName)/Source</pre>
## Enter a solution name (optionally, tick "Place solution and project in the same directory")
## Make sure Framework is ".NET Framework 4.7.2"
# In your project, set target framework and various other properties
## In your Solution Explorer (the panel usually located on the right), right click your project -> Properties (or expand your project and double click "Properties" with the wrench icon)
## ''Optional'': Under Application, change your Assembly and Namespace names to anything of your choice
## Go to Build -> Advanced... and set "Debugging information" to none
## Leave Advanced..., and set the Output Path to "..\..\Assemblies\" (Or wherever the Assemblies folder is)
# Add references to RimWorld code
## Expand your project in Solution Explorer. Then right click "References" -> Add Reference...
## Click Browse...
## Navigate towards <pre>RimWorldInstallPath/RimWorld******_Data/Managed</pre> and select files: <pre>Assembly-CSharp.dll
UnityEngine.CoreModule.dll</pre>
## Click "Add"
## Click "OK" to close the Reference Manager.
## Right-click on both Assembly-CSharp.dll and UnityEngine.dll and set Copy Local to False (Properties pane).

====Option 2 (Using Nuget):====
This option uses [https://www.nuget.org/packages/Krafs.Rimworld.Ref Krafs Rimworld Reference Package] it is less involved than using reference assemblies and is the recommended method.
#Follow the above up till ''Add references to RimWorld code''
#Open Nuget Manager and type ''Rimworld''
#Add Krafs Rimworld Reference
#When prompted '''Select packagereference''' (this is required for the package to be added)
You can now continue as if you added the assemblies
Doing this makes your project portable, because RimRef can be downloaded by anyone and used from anywhere, unlike Rimworld's assemblies which can't be distributed.

====Option 3 (Using Rimworld Dotnet Template):====
This option uses [https://github.com/Burgess12/Rimwold-Dotnet-Template Rimworld Dotnet Template] it allows faster creation of mod files including Xml foulders

After installing the template.
#Open your mod folder
#create a new folder for your mod (It is best to use the name you want for your mod)
#Open a command prompt in that folder
#type ''dotnet new RimMod'' (This will create a new mod with the name you specified)
#Open the About folder and edit the About.xml file
#Open the .sln file in your preferred IDE
#Add the rimworld assemblies using your preferred method

While this method is faster, it is still good to know how to do it manually.

====Option 4 (Using Cookiecutter):====
This option uses the [https://ludeon.com/forums/index.php?topic=39038.0 Rimworld Mod Development Cookiecutter] tool.
'''Note: despite being automatic and potentially taking away some of the tedium away, the environment it sets up is very particular and this tool is currently not recommended for newcomers.'''
''As of Jan 2019, the cookiecutter is set up for Windows development. Linux/Mac people can still use it, but they will have a few errors to clean up.''
# Open Visual Studio
# Once loaded, go to File -> New -> From Cookiecutter...
# Search for ''rimworld''
# Double-click ''cookiecutter-rimworld-mod-development''
# Change the Template Options:
## ''Create To'' => ''Your/Rimworld/Mod/Directory''
## ''mod_name''
## ''namespace_name'' (don't change if unsure)
## ''author'' => ''your steam username''
## ''target_version'' => current RW version (can leave blank for most up-to-date)
## ''in_game_description'' (not required, can change later in About-Release.xml)
## ''url'' (can leave blank for link to your Steam Workshop profile)
# Click "Create and Open Folder"

===Sharpdevelop===
'''Caution:''' Sharpdevelop (or #develop) does NOT CURRENTLY allow for C# 6.0+ syntax without plugins and does NOT ALLOW for C# 7.0+ syntax at all. For your average project this does not matter, however some existing projects are already built entirely upon C# 6.0+ syntax which can not be compiled anymore in Sharpdevelop. Visual Studio does not have these issues and should be your go-to for compiling large projects such as Combat Extended.

# Create a new class library project in your [[Modding Tutorials/Recommended software#IDE.27s|IDE of choice]];
## Go to File -> New -> Solution;
## Go to C# or .NET -> Library or Class Library (NOT portable);
## Enter a project name (solution name automatically updated);
## Choose a location, preferably: <pre>(RimWorldInstallFolder)/Mods/(YourModName)/Source</pre>
## ''Optional'': Untick "Create a directory for solution"/"Create a project within the solution directory",
# In your project, add references to Assembly-CSharp.dll and UnityEngine.dll:
## In your IDE project file browser, right-click the "References" folder and "Add reference";
## Choose the ".NET Assembly Browser" tab and "Browse...";
## Navigate towards <pre>RimWorld******/RimWorld******_Data/Managed</pre> and select files: <pre>Assembly-CSharp.dll
UnityEngine.CoreModule.dll</pre>
## Click "Open" then "OK";
## In the References folder, right-click Assembly-CSharp -> Properties and change "Local copy" to False. Do the same for UnityEngine,
# In your project properties, change the target framework to .NET 4.7.2:
## In your IDE project file browser, right-click "(YourSolutionName)";
## Choose Properties;
## Go to the "Compiling" tab, "Output", "Target framework", "Change" and choose ".NET Framework 4.7.2",
# In your project properties, change the build events so only a single file is built:
## Go to the "Compiling" tab, "Output", "Debug info" and choose "No debug information";
## Right-click your .cs files -> Properties and change "Copy to output" (If you haven't resized the properties bar, this will be truncated to "Copy to out") to Never,
# In your project properties, fix the output location to put the DLL in the Assemblies folder:
## Go to the "Compiling" tab, "Output", "Output path" and change the output path to "..\..\Assemblies\". 

===Xamarin/MonoDevelop===
The setup is similar as the one above. A few special points to address:
# Mono 4.X isn't backward compatible so you may need to install an older 3.X version of Mono in order to compile against .NET4.7.2 dlls.
# Make sure you uncheck "Use MSBuild build engine (recommended for this project type)" under project > options > build > general (You might find this by right-clicking on your project - not solution - name and selecting options)
# Changing the framework to 4.7.2 can be found (for Linux anyway) in the same place.

More detailed installation instructions for Linux can be found [https://blog.rubenwardy.com/2016/07/21/rimworld-setup-monodevelop/ here] and [https://spdskatr.github.io/RWModdingResources/mono-arch here]. Note that as of now (2021) these may be outdated, so if it doesn't work, you can try the steps described in the Mono section.

===Mono===
On Linux and Mac(?) it is possible to use Mono regardless of IDE (from command line, or if your IDE/editor has build support).
# Install Mono (refer to your distribution's instructions);
# To build using .csproj files that other setups use, you need the ''dotnet'' tool, you can get it by installing the [https://dotnet.microsoft.com/download .NET SDK];
# If you're starting a new mod and want to use a .csproj file for compatibility with other modders, find e.g. a mod that has description pointing to its GitHub sources and copy from there;
# For building use a command like the following (substitute the proper .csproj file and 4.7.2 is the .NET version from the .csproj file): <pre>FrameworkPathOverride=$(dirname $(which mono))/../lib/mono/4.7.2-api/ dotnet build <project file>.csproj /property:Configuration=Release</pre>
# If you get errors, it is necessary to edit the .csproj file:
## You may need to fix paths (point them to .dll files in RimWorld/RimWorld*_Data/Managed);
## See other setups above for other settings (those IDEs write those settings to the .csproj files);

===Rider (good for Mac)===
JetBrains Rider is a great cross-platform C# IDE, but it isn't cheap. It's $140 for the first year, including perpetual access to that version (access to future updates gets cheaper, but it's still over $100/year). However, the Early Access versions are a bit unstable but free. They also offer free student licenses.

# Open Rider and click New Solution in the welcome dialog.
## Click Class Library under .NET on the left. The option may a second to show up.
## Under Solution Name (and Project Name), enter the name of your mod.
## Set the Solution Directory to [your mod folder]/Source.
## Optionally check "put solution and project in the same directory." This is probably a good idea.
## Change Framework to .Net Framework 4.7.2.
## Click Create.
# In the left side bar, expand your solution, right click your project (mod name with "C#" icon) and click Properties.
## In the Properties window, select Configurations > Debug on the left and uncheck Debug Symbols.
## For both configurations, change the Output Path to ../../Assemblies.
## Click OK.
# Expand your project, right click References and click Add Reference.
## Click Add From.
## Browse to the folder with the RimWorld DLLs (Mac: /Users/[username]/Library/Application Support/Steam/steamapps/common/RimWorld/RimWorldMac.app/Contents/Resources/Data/Managed).
## Select both Assembly-CSharp.dll and UnityEngine.dll and click OK.
## Expand Assemblies under References. For both of the assemblies that you just added:
### Right click the assembly and click Properties.
### Uncheck "Copy Local" (you may need to scroll down) and click OK.

You're done! Note that Rider has a built-in decompiler—to view the source of a RimWorld class or method, just right-click its name and click Go To > Definition.

=Common issues=
* Can't find the option to target .NET Framework 4.7.2? It may require additional installation steps. In Visual Studio, Tools => Get Tools and features => Individual Components => Select ''.NET Framework 4.7.2 development tools'' (or google installation instructions). Also make sure your project is a ''Class Library (.NET '''Framework''')''. Not .NET Core or .NET Standard.

=See also=
* [[Modding Tutorials/Writing custom code|Writing custom code]] continues on setting up your solution. 

[[Category:Modding tutorials]]

Modding Tutorials/Setting up a solution

2023-04-05T05:08:41Z

Zeta18: Added section on Rimworld Dotnet Template

{{BackToTutorials}}
{{Credit|[[User:Alistaire|Alistaire]]}} 

In this tutorial you will learn how to set up a solution, along with instructions on setting the output directory and files for more convenient building right into the Assemblies folder.

=Requirements=

* The manual option in this tutorial requires you to have [[Modding_Tutorials/Mod_folder_structure#The Source and Assemblies folders|set up a Source and Assemblies folder]] (the Visual Studio automatic option sets this up for you).
* You will want to have an IDE installed: [[Modding Tutorials/Recommended software#IDE's|Recommended IDE's]]. 

=Setting up a solution=
Setting up can be different for different IDE's. Feel free to add '''''complete''''' instructions for your IDE of choice.

===Visual Studio Community 2019===
''NOTE: Visual Studio 2019 is a rather heavy application (2-3 GB for basic functionality) but has a bit more functionality. Only Install if your computer can handle it! This tutorial is similar for other versions of Visual Studio.''

==== Option 1 (Manual Method):====
# Create a new class library project
## Once loaded, go to File -> New -> Project...
## Type "Class Library (.NET Framework)" in the search bar, and select the C# option. [[File:ClassLibrary.png|200px|thumb|right|Installing the .NET framework]]
## Enter your project name.
## Choose a location, preferably: <pre>(RimWorldInstallFolder)/Mods/(YourModName)/Source</pre>
## Enter a solution name (optionally, tick "Place solution and project in the same directory")
## Make sure Framework is ".NET Framework 4.7.2"
# In your project, set target framework and various other properties
## In your Solution Explorer (the panel usually located on the right), right click your project -> Properties (or expand your project and double click "Properties" with the wrench icon)
## ''Optional'': Under Application, change your Assembly and Namespace names to anything of your choice
## Go to Build -> Advanced... and set "Debugging information" to none
## Leave Advanced..., and set the Output Path to "..\..\Assemblies\" (Or wherever the Assemblies folder is)
# Add references to RimWorld code
## Expand your project in Solution Explorer. Then right click "References" -> Add Reference...
## Click Browse...
## Navigate towards <pre>RimWorldInstallPath/RimWorld******_Data/Managed</pre> and select files: <pre>Assembly-CSharp.dll
UnityEngine.CoreModule.dll</pre>
## Click "Add"
## Click "OK" to close the Reference Manager.
## Right-click on both Assembly-CSharp.dll and UnityEngine.dll and set Copy Local to False (Properties pane).

====Option 2 (Using Nuget):====
This option uses [https://www.nuget.org/packages/Krafs.Rimworld.Ref Krafs Rimworld Reference Package] it is less involved than using reference assemblies and is the recommended method.
#Follow the above up till ''Add references to RimWorld code''
#Open Nuget Manager and type ''Rimworld''
#Add Krafs Rimworld Reference
#When prompted '''Select packagereference''' (this is required for the package to be added)
You can now continue as if you added the assemblies
Doing this makes your project portable, because RimRef can be downloaded by anyone and used from anywhere, unlike Rimworld's assemblies which can't be distributed.

===Option 3 (Using Rimworld Dotnet Template):===
This option uses [https://github.com/Burgess12/Rimwold-Dotnet-Template Rimworld Dotnet Template] it allows faster creation of mod files including Xml foulders

After installing the template.
#Open your mod folder
#create a new folder for your mod (It is best to use the name you want for your mod)
#Open a command prompt in that folder
#type ''dotnet new RimMod'' (This will create a new mod with the name you specified)
#Open the About folder and edit the About.xml file
#Open the .sln file in your preferred IDE
#Add the rimworld assemblies using your preferred method

While this method is faster, it is still good to know how to do it manually.

====Option 4 (Using Cookiecutter):====
This option uses the [https://ludeon.com/forums/index.php?topic=39038.0 Rimworld Mod Development Cookiecutter] tool.
'''Note: despite being automatic and potentially taking away some of the tedium away, the environment it sets up is very particular and this tool is currently not recommended for newcomers.'''
''As of Jan 2019, the cookiecutter is set up for Windows development. Linux/Mac people can still use it, but they will have a few errors to clean up.''
# Open Visual Studio
# Once loaded, go to File -> New -> From Cookiecutter...
# Search for ''rimworld''
# Double-click ''cookiecutter-rimworld-mod-development''
# Change the Template Options:
## ''Create To'' => ''Your/Rimworld/Mod/Directory''
## ''mod_name''
## ''namespace_name'' (don't change if unsure)
## ''author'' => ''your steam username''
## ''target_version'' => current RW version (can leave blank for most up-to-date)
## ''in_game_description'' (not required, can change later in About-Release.xml)
## ''url'' (can leave blank for link to your Steam Workshop profile)
# Click "Create and Open Folder"

===Sharpdevelop===
'''Caution:''' Sharpdevelop (or #develop) does NOT CURRENTLY allow for C# 6.0+ syntax without plugins and does NOT ALLOW for C# 7.0+ syntax at all. For your average project this does not matter, however some existing projects are already built entirely upon C# 6.0+ syntax which can not be compiled anymore in Sharpdevelop. Visual Studio does not have these issues and should be your go-to for compiling large projects such as Combat Extended.

# Create a new class library project in your [[Modding Tutorials/Recommended software#IDE.27s|IDE of choice]];
## Go to File -> New -> Solution;
## Go to C# or .NET -> Library or Class Library (NOT portable);
## Enter a project name (solution name automatically updated);
## Choose a location, preferably: <pre>(RimWorldInstallFolder)/Mods/(YourModName)/Source</pre>
## ''Optional'': Untick "Create a directory for solution"/"Create a project within the solution directory",
# In your project, add references to Assembly-CSharp.dll and UnityEngine.dll:
## In your IDE project file browser, right-click the "References" folder and "Add reference";
## Choose the ".NET Assembly Browser" tab and "Browse...";
## Navigate towards <pre>RimWorld******/RimWorld******_Data/Managed</pre> and select files: <pre>Assembly-CSharp.dll
UnityEngine.CoreModule.dll</pre>
## Click "Open" then "OK";
## In the References folder, right-click Assembly-CSharp -> Properties and change "Local copy" to False. Do the same for UnityEngine,
# In your project properties, change the target framework to .NET 4.7.2:
## In your IDE project file browser, right-click "(YourSolutionName)";
## Choose Properties;
## Go to the "Compiling" tab, "Output", "Target framework", "Change" and choose ".NET Framework 4.7.2",
# In your project properties, change the build events so only a single file is built:
## Go to the "Compiling" tab, "Output", "Debug info" and choose "No debug information";
## Right-click your .cs files -> Properties and change "Copy to output" (If you haven't resized the properties bar, this will be truncated to "Copy to out") to Never,
# In your project properties, fix the output location to put the DLL in the Assemblies folder:
## Go to the "Compiling" tab, "Output", "Output path" and change the output path to "..\..\Assemblies\". 

===Xamarin/MonoDevelop===
The setup is similar as the one above. A few special points to address:
# Mono 4.X isn't backward compatible so you may need to install an older 3.X version of Mono in order to compile against .NET4.7.2 dlls.
# Make sure you uncheck "Use MSBuild build engine (recommended for this project type)" under project > options > build > general (You might find this by right-clicking on your project - not solution - name and selecting options)
# Changing the framework to 4.7.2 can be found (for Linux anyway) in the same place.

More detailed installation instructions for Linux can be found [https://blog.rubenwardy.com/2016/07/21/rimworld-setup-monodevelop/ here] and [https://spdskatr.github.io/RWModdingResources/mono-arch here]. Note that as of now (2021) these may be outdated, so if it doesn't work, you can try the steps described in the Mono section.

===Mono===
On Linux and Mac(?) it is possible to use Mono regardless of IDE (from command line, or if your IDE/editor has build support).
# Install Mono (refer to your distribution's instructions);
# To build using .csproj files that other setups use, you need the ''dotnet'' tool, you can get it by installing the [https://dotnet.microsoft.com/download .NET SDK];
# If you're starting a new mod and want to use a .csproj file for compatibility with other modders, find e.g. a mod that has description pointing to its GitHub sources and copy from there;
# For building use a command like the following (substitute the proper .csproj file and 4.7.2 is the .NET version from the .csproj file): <pre>FrameworkPathOverride=$(dirname $(which mono))/../lib/mono/4.7.2-api/ dotnet build <project file>.csproj /property:Configuration=Release</pre>
# If you get errors, it is necessary to edit the .csproj file:
## You may need to fix paths (point them to .dll files in RimWorld/RimWorld*_Data/Managed);
## See other setups above for other settings (those IDEs write those settings to the .csproj files);

===Rider (good for Mac)===
JetBrains Rider is a great cross-platform C# IDE, but it isn't cheap. It's $140 for the first year, including perpetual access to that version (access to future updates gets cheaper, but it's still over $100/year). However, the Early Access versions are a bit unstable but free. They also offer free student licenses.

# Open Rider and click New Solution in the welcome dialog.
## Click Class Library under .NET on the left. The option may a second to show up.
## Under Solution Name (and Project Name), enter the name of your mod.
## Set the Solution Directory to [your mod folder]/Source.
## Optionally check "put solution and project in the same directory." This is probably a good idea.
## Change Framework to .Net Framework 4.7.2.
## Click Create.
# In the left side bar, expand your solution, right click your project (mod name with "C#" icon) and click Properties.
## In the Properties window, select Configurations > Debug on the left and uncheck Debug Symbols.
## For both configurations, change the Output Path to ../../Assemblies.
## Click OK.
# Expand your project, right click References and click Add Reference.
## Click Add From.
## Browse to the folder with the RimWorld DLLs (Mac: /Users/[username]/Library/Application Support/Steam/steamapps/common/RimWorld/RimWorldMac.app/Contents/Resources/Data/Managed).
## Select both Assembly-CSharp.dll and UnityEngine.dll and click OK.
## Expand Assemblies under References. For both of the assemblies that you just added:
### Right click the assembly and click Properties.
### Uncheck "Copy Local" (you may need to scroll down) and click OK.

You're done! Note that Rider has a built-in decompiler—to view the source of a RimWorld class or method, just right-click its name and click Go To > Definition.

=Common issues=
* Can't find the option to target .NET Framework 4.7.2? It may require additional installation steps. In Visual Studio, Tools => Get Tools and features => Individual Components => Select ''.NET Framework 4.7.2 development tools'' (or google installation instructions). Also make sure your project is a ''Class Library (.NET '''Framework''')''. Not .NET Core or .NET Standard.

=See also=
* [[Modding Tutorials/Writing custom code|Writing custom code]] continues on setting up your solution. 

[[Category:Modding tutorials]]

Modding Tutorials/Setting up a solution

2023-04-05T00:55:05Z

Zeta18: Add section about Krafs RimRef

{{BackToTutorials}}
{{Credit|[[User:Alistaire|Alistaire]]}} 

In this tutorial you will learn how to set up a solution, along with instructions on setting the output directory and files for more convenient building right into the Assemblies folder.

=Requirements=

* The manual option in this tutorial requires you to have [[Modding_Tutorials/Mod_folder_structure#The Source and Assemblies folders|set up a Source and Assemblies folder]] (the Visual Studio automatic option sets this up for you).
* You will want to have an IDE installed: [[Modding Tutorials/Recommended software#IDE's|Recommended IDE's]]. 

=Setting up a solution=
Setting up can be different for different IDE's. Feel free to add '''''complete''''' instructions for your IDE of choice.

===Visual Studio Community 2019===
''NOTE: Visual Studio 2019 is a rather heavy application (2-3 GB for basic functionality) but has a bit more functionality. Only Install if your computer can handle it! This tutorial is similar for other versions of Visual Studio.''

==== Option 1 (Manual Method):====
# Create a new class library project
## Once loaded, go to File -> New -> Project...
## Type "Class Library (.NET Framework)" in the search bar, and select the C# option. [[File:ClassLibrary.png|200px|thumb|right|Installing the .NET framework]]
## Enter your project name.
## Choose a location, preferably: <pre>(RimWorldInstallFolder)/Mods/(YourModName)/Source</pre>
## Enter a solution name (optionally, tick "Place solution and project in the same directory")
## Make sure Framework is ".NET Framework 4.7.2"
# In your project, set target framework and various other properties
## In your Solution Explorer (the panel usually located on the right), right click your project -> Properties (or expand your project and double click "Properties" with the wrench icon)
## ''Optional'': Under Application, change your Assembly and Namespace names to anything of your choice
## Go to Build -> Advanced... and set "Debugging information" to none
## Leave Advanced..., and set the Output Path to "..\..\Assemblies\" (Or wherever the Assemblies folder is)
# Add references to RimWorld code
## Expand your project in Solution Explorer. Then right click "References" -> Add Reference...
## Click Browse...
## Navigate towards <pre>RimWorldInstallPath/RimWorld******_Data/Managed</pre> and select files: <pre>Assembly-CSharp.dll
UnityEngine.CoreModule.dll</pre>
## Click "Add"
## Click "OK" to close the Reference Manager.
## Right-click on both Assembly-CSharp.dll and UnityEngine.dll and set Copy Local to False (Properties pane).

====Option 2 (Using Nuget):====
This option uses [https://https://www.nuget.org/packages/Krafs.Rimworld.Ref Krafs Rimworld Reference Package] it is less involved than using reference assemblies and is the recommended method.
#Follow the above up till ''Add references to RimWorld code''
#Open Nuget Manager and type ''Rimworld''
#Add Krafs Rimworld Reference
#When prompted '''Select packagereference''' (this is required for the package to be add)
You can now continue as if you added the assemblies
Doing this makes your project portable, because RimRef can be downloaded by anyone and used from anywhere, unlike Rimworld's assemblies which can't be distributed.

====Option 3 (Using Cookiecutter):====
This option uses the [https://ludeon.com/forums/index.php?topic=39038.0 Rimworld Mod Development Cookiecutter] tool.
'''Note: despite being automatic and potentially taking away some of the tedium away, the environment it sets up is very particular and this tool is currently not recommended for newcomers.'''
''As of Jan 2019, the cookiecutter is set up for Windows development. Linux/Mac people can still use it, but they will have a few errors to clean up.''
# Open Visual Studio
# Once loaded, go to File -> New -> From Cookiecutter...
# Search for ''rimworld''
# Double-click ''cookiecutter-rimworld-mod-development''
# Change the Template Options:
## ''Create To'' => ''Your/Rimworld/Mod/Directory''
## ''mod_name''
## ''namespace_name'' (don't change if unsure)
## ''author'' => ''your steam username''
## ''target_version'' => current RW version (can leave blank for most up-to-date)
## ''in_game_description'' (not required, can change later in About-Release.xml)
## ''url'' (can leave blank for link to your Steam Workshop profile)
# Click "Create and Open Folder"

===Sharpdevelop===
'''Caution:''' Sharpdevelop (or #develop) does NOT CURRENTLY allow for C# 6.0+ syntax without plugins and does NOT ALLOW for C# 7.0+ syntax at all. For your average project this does not matter, however some existing projects are already built entirely upon C# 6.0+ syntax which can not be compiled anymore in Sharpdevelop. Visual Studio does not have these issues and should be your go-to for compiling large projects such as Combat Extended.

# Create a new class library project in your [[Modding Tutorials/Recommended software#IDE.27s|IDE of choice]];
## Go to File -> New -> Solution;
## Go to C# or .NET -> Library or Class Library (NOT portable);
## Enter a project name (solution name automatically updated);
## Choose a location, preferably: <pre>(RimWorldInstallFolder)/Mods/(YourModName)/Source</pre>
## ''Optional'': Untick "Create a directory for solution"/"Create a project within the solution directory",
# In your project, add references to Assembly-CSharp.dll and UnityEngine.dll:
## In your IDE project file browser, right-click the "References" folder and "Add reference";
## Choose the ".NET Assembly Browser" tab and "Browse...";
## Navigate towards <pre>RimWorld******/RimWorld******_Data/Managed</pre> and select files: <pre>Assembly-CSharp.dll
UnityEngine.CoreModule.dll</pre>
## Click "Open" then "OK";
## In the References folder, right-click Assembly-CSharp -> Properties and change "Local copy" to False. Do the same for UnityEngine,
# In your project properties, change the target framework to .NET 4.7.2:
## In your IDE project file browser, right-click "(YourSolutionName)";
## Choose Properties;
## Go to the "Compiling" tab, "Output", "Target framework", "Change" and choose ".NET Framework 4.7.2",
# In your project properties, change the build events so only a single file is built:
## Go to the "Compiling" tab, "Output", "Debug info" and choose "No debug information";
## Right-click your .cs files -> Properties and change "Copy to output" (If you haven't resized the properties bar, this will be truncated to "Copy to out") to Never,
# In your project properties, fix the output location to put the DLL in the Assemblies folder:
## Go to the "Compiling" tab, "Output", "Output path" and change the output path to "..\..\Assemblies\". 

===Xamarin/MonoDevelop===
The setup is similar as the one above. A few special points to address:
# Mono 4.X isn't backward compatible so you may need to install an older 3.X version of Mono in order to compile against .NET4.7.2 dlls.
# Make sure you uncheck "Use MSBuild build engine (recommended for this project type)" under project > options > build > general (You might find this by right-clicking on your project - not solution - name and selecting options)
# Changing the framework to 4.7.2 can be found (for Linux anyway) in the same place.

More detailed installation instructions for Linux can be found [https://blog.rubenwardy.com/2016/07/21/rimworld-setup-monodevelop/ here] and [https://spdskatr.github.io/RWModdingResources/mono-arch here]. Note that as of now (2021) these may be outdated, so if it doesn't work, you can try the steps described in the Mono section.

===Mono===
On Linux and Mac(?) it is possible to use Mono regardless of IDE (from command line, or if your IDE/editor has build support).
# Install Mono (refer to your distribution's instructions);
# To build using .csproj files that other setups use, you need the ''dotnet'' tool, you can get it by installing the [https://dotnet.microsoft.com/download .NET SDK];
# If you're starting a new mod and want to use a .csproj file for compatibility with other modders, find e.g. a mod that has description pointing to its GitHub sources and copy from there;
# For building use a command like the following (substitute the proper .csproj file and 4.7.2 is the .NET version from the .csproj file): <pre>FrameworkPathOverride=$(dirname $(which mono))/../lib/mono/4.7.2-api/ dotnet build <project file>.csproj /property:Configuration=Release</pre>
# If you get errors, it is necessary to edit the .csproj file:
## You may need to fix paths (point them to .dll files in RimWorld/RimWorld*_Data/Managed);
## See other setups above for other settings (those IDEs write those settings to the .csproj files);

===Rider (good for Mac)===
JetBrains Rider is a great cross-platform C# IDE, but it isn't cheap. It's $140 for the first year, including perpetual access to that version (access to future updates gets cheaper, but it's still over $100/year). However, the Early Access versions are a bit unstable but free. They also offer free student licenses.

# Open Rider and click New Solution in the welcome dialog.
## Click Class Library under .NET on the left. The option may a second to show up.
## Under Solution Name (and Project Name), enter the name of your mod.
## Set the Solution Directory to [your mod folder]/Source.
## Optionally check "put solution and project in the same directory." This is probably a good idea.
## Change Framework to .Net Framework 4.7.2.
## Click Create.
# In the left side bar, expand your solution, right click your project (mod name with "C#" icon) and click Properties.
## In the Properties window, select Configurations > Debug on the left and uncheck Debug Symbols.
## For both configurations, change the Output Path to ../../Assemblies.
## Click OK.
# Expand your project, right click References and click Add Reference.
## Click Add From.
## Browse to the folder with the RimWorld DLLs (Mac: /Users/[username]/Library/Application Support/Steam/steamapps/common/RimWorld/RimWorldMac.app/Contents/Resources/Data/Managed).
## Select both Assembly-CSharp.dll and UnityEngine.dll and click OK.
## Expand Assemblies under References. For both of the assemblies that you just added:
### Right click the assembly and click Properties.
### Uncheck "Copy Local" (you may need to scroll down) and click OK.

You're done! Note that Rider has a built-in decompiler—to view the source of a RimWorld class or method, just right-click its name and click Go To > Definition.

=Common issues=
* Can't find the option to target .NET Framework 4.7.2? It may require additional installation steps. In Visual Studio, Tools => Get Tools and features => Individual Components => Select ''.NET Framework 4.7.2 development tools'' (or google installation instructions). Also make sure your project is a ''Class Library (.NET '''Framework''')''. Not .NET Core or .NET Standard.

=See also=
* [[Modding Tutorials/Writing custom code|Writing custom code]] continues on setting up your solution. 

[[Category:Modding tutorials]]