New Modder Tips and Resources - erdelf/AlienRaces GitHub Wiki
Tips for New Race Modders
- Custom humanlike races are complex and time-consuming to make! If you are new to RimWorld modding, it is strongly recommended that you cut your teeth on simpler content first, such as weapons, apparel, or animals. If you are unfamiliar with any of the following game systems, please check out the link to the general RimWorld tutorials further down the page: race Defs, race properties, PawnKindDefs, faction Defs (if you are making a custom faction for your face), and player factions (if you are making a starting scenario for your race).
- Please read the whole wiki! The wiki has comprehensive documentation for all commonly used functions of the framework, so chances are whatever basic questions you have will be answered somewhere in it!
- If you are having difficulty understanding how everything fits together or would otherwise like a working reference, try looking at a simple race mod to see it's made: Rockmen by goudaQuiche, Bun Race by Spanky-H (Warning: out of date, has not been updated to 1.3)
- If you are unsure about how something works, just try it out! A lot of the XML starts to make more sense once you play around with it. Feel free to reach out if you can't get it to work, often times there is no substitute for just trial by error.
- Join the RimWorld Alien Races Discord. Be sure to search for keywords on things you're trying to figure out; often times people have already had a discussion about the thing you're trying to figure out and you can quickly find answers that way!
- Often times, Google searches for those same keywords can yield useful results as well!
- Use Quicktest for testing out your race (or any mod in development in general). It lets you test things much faster by launching Rimworld immediately onto a small map with pawns.
- Be sure to check out the rest of the resources on this page as well!
Useful File Locations:
Vanilla RimWorld content, including XML Defs and translation files for both the Core game and official DLCs, can be found in your Steam directory here:
C:\Program Files (x86)\Steam\SteamApps\common\RimWorld\Data\
Your local mod folder where you should copy your mods to for test (and where Mod Manager and RimPy save mods to) is here:
C:\Program Files (x86)\Steam\SteamApps\common\RimWorld\Mods
Some useful modding information directly provided by Tynan and Ludeon:
C:\Program Files (x86)\Steam\SteamApps\common\RimWorld\ModUpdating.txt
RimWorld log location, useful for sharing or if your game crashes on load such that you never even reach the main menu:
C:\Users\[YourUserName]\AppData\LocalLow\Ludeon Studios\RimWorld by Ludeon Studios\Player.log
Templates
It is recommended that you instead start with a blank race and only add what you need, as using a template results in potentially hundreds of lines of unneeded settings. The Getting Started tutorial has a link to a blank race if you need help setting up a mod folder for the first time.
The following templates were provided by goudaQuiche. However, they are at the time of writing out of date and no longer useful in starting a new race project:
Art and Textures
- You can find a link to the official RimWorld Art Source in this post on the official Ludeon forums. These are useful in finding body and apparel templates for your race, as the published game assets are packed into a Unity asset bundle and cannot be directly opened in an external graphics program.
- Colouring In Images - A useful guide on how RimWorld applies colors and color masks.
- Officially Unofficial Guide to Rimworld's Artstyle - A guide on RimWorld's art style, based on a talk given by Tynan at Game Developer's Conference (GDC) 2017.
Modding XML & C#
General Modding Tutorials:
-
Modding Tutorials on the RimWorld Wiki - The most reliable source of modding information, especially the basics such as mod folder layout and Def structures.
-
Mod Folder Structure - A guide to how mod folders should be laid out.
-
PatchOperations Guide - A guide on how to use PatchOperations to modify existing XML Defs. A full reference for vanilla PatchOperations can also be found on the RimWorld wiki.
-
Plague Gun (1.1) - The go-to comprehensive tutorial for RimWorld, which covers all the basics including XML Defs and custom C# assemblies. Includes a link to a working repository. Still relevant as of 1.3, not much to do with weapons has changed since 1.1.
-
(Mostly outdated, has not been updated since 1.0) spdskatr's RimWorld Modding Resources - Still has links to many useful resources, though.
-
(Outdated, has not been updated since 2017) Roxxploxx's Modding Guide
Advanced Modding Topics:
- Harmony 2 Documentation - Harmony is a library used by modders for RimWorld and many other Unity/C# based games. Based on Reflection, it is used to intercept (patch) method calls and access restricted fields in advanced mods.
- (Slightly Outdated) Combat Extended Compatibility - A guide on how to make your race compatible with Combat Extended. Should also check the up to date reference sheet for the updated CE repository.