This is a collection of tutorials for Rimworld modding. It contains code examples and explanations for tutorials on the Rimworld Wiki . as well as the Markdown files for the wiki.
If you want to use the code examples, you can download the repository as a zip file or if you want to use git, open a terminal to where you want to clone the repository and run the following command:
git clone https://github.com/Zeta-of-the-rim/RimWorld-Mod-Tutorials.git "RimWorld Mod Tutorials"If you want to contribute to the wiki, you don't need to clone the repository. You can just edit the wiki pages directly on the wiki.
On top of the Markdown files for the wiki, this repository also contains Markdown files designed to be viewed on GitHub. These files are identical to the wiki pages except they have been formatted to be viewed on GitHub. These files are Named TUTORIALNAME-GitHub.md and are next to the wiki pages.
EDIT: I am not currently converting the wiki pages to GitHub format as I currently don't have the time (and it takes forever).
If you
A: want to help, feel free to make a pull request.
B: Know how to convert the wiki pages to GitHub format, let me know and I will add you as a collaborator.
Some links to important resources for Rimworld modding.
- Other Rimworld Modding Tutorials
- Rimworld Modding Discord
- My Rimworld Mod Template (Good for Making the files structure for your mod)
If you are not familiar with C#, .NET or any Java-like language, you should probably learn the basics before you start modding.
If this is your first time attempting any sort of programming, I beg you to start with a simpler language like Python or JavaScript. C# is not a good place to start and Rimworld modding is even worse.
Before you start modding, you should install the following tools:
- .NET Framework 4.7.2 (Required to compile C# code)
- Git (Useful for version control and backing up your mod)
- Visual Studio Code (Good for editing XML code)
- Visual Studio 2022 (The Go to free IDE for C# code)
- Rider (free for students. I prefer this over Visual Studio)
- ilSpy (Good for decompiling Rimworld's DLLs)
- dotPeek (Slow. but an alternative to ilSpy)
- GitHub Copilot (While a great tool, it struggles with Rimworld's code. Still good for helping with the basics and writing comments)
- Rimworld Wiki for hosting the tutorials and providing a place for the community to learn.
- Rimworld Modding Discord for being an all-around great group of unconvicted war criminals.
- The one true god, Randy Random, for blessing us with his wisdom and mercy. (Take that Cassandra)
