Difference between revisions of "Modding"

Latest revision as of 17:55, 17 August 2024

Basics

Menus

Game Creation

Game modifications (or mods) are a way of altering the way the game functions by adding, changing, or removing content such as items, textures, sounds, or more. RimWorld has built-in support for modding, including Steam Workshop support.

Using Mods[edit]

If you own RimWorld on Steam, then the easiest way of finding and downloading mods is by using Steam Workshop. Steam Workshop automates the process of downloading and installing mods, as well as keeping them up to date with new releases.

Even if you do not own RimWorld on Steam, Workshop can still be used to discover new mods; while some mods are released on Nexus Mods, no other mod site has close to the same amount of mods available. You can use tools such as RimPy and RimSort to download and install mods from Steam Workshop and GitHub instead.

Manual Installation[edit]

You can install mods manually by unzipping them into subfolders within your local Mods folder. This location varies by operating system:

Operating System	Default Folder Location
Windows	`C:\Program Files (x86)\Steam\steamapps\common\RimWorld\Mods`
Mac	`Library/Application Support/Steam/steamapps/common/RimWorld`
Linux (standalone)	`~/.steam/steam/steamapps/common/RimWorld/Mods`
Linux (GoG)	`/home/<user>/GOG/Games/RimWorld/game/Mods/`

Activating Mods[edit]

Once you have installed mods, you can select the Mods option from the main menu of RimWorld to activate them. Activating or deactivating mods requires RimWorld to restart.

Making Mods[edit]

Please check out the Modding Tutorials hub for tutorials and guides on how to create and publish your own mods.

@@ Line 1: / Line 1: @@
-__NOTOC__
+<!--Top Nav Box-->
+{| align=center
+| {{Basics_Nav}}
+|}
+----
-==MODs files are stored in:==
+'''Game modifications''' (or '''mods''') are a way of altering the way the game functions by adding, changing, or removing content such as items, textures, sounds, or more. RimWorld has built-in support for modding, including Steam Workshop support.
-[[File:Folders-OS-Windows-8-Metro-icon.png|36px|link=]] [[File:Folders-OS-Linux-Metro-icon.png|36px|link=]] [[File:Folders-OS-Apple-Metro-icon.png|36px|link=]]
-<code>path to game folder/Mods</code>
+== Using Mods ==
-== How to install mods ==
+If you own RimWorld on Steam, then the easiest way of finding and downloading mods is by using [https://steamcommunity.com/app/294100/workshop/ Steam Workshop]. Steam Workshop automates the process of downloading and installing mods, as well as keeping them up to date with new releases.
-Finding and Installing mods which is short for modification to your RimWorld is a very easy task to do if you want to add some new content to your game. First you need to look online and find a mod that you want to try out, the main source for finding mods is [[http://ludeon.com/forums/index.php?board=15.0 forum]] which is the mod release section on the main Ludeon site. Once you find a mod you like that is COMPATIBLE with the VERSION of RimWorld you have, or even a few mods you like you can download them from there page in the mod release forum. Once you have downloaded them and opened up your .rar files you just got, its a simple case of drag and dropping the mod folders inside the .rar files into you RimWorld mods folder, Starting up your game and activating the mods. A lot of the RimWorld mods require you to start a new game before the new content is available.
-== Editing mods folder ==
+Even if you do not own RimWorld on Steam, Workshop can still be used to discover new mods; while some mods are released on [https://www.nexusmods.com/rimworld Nexus Mods], no other mod site has close to the same amount of mods available. You can use tools such as [https://github.com/rimpy-custom/RimPy/releases RimPy] and [https://github.com/RimSort/RimSort RimSort] to download and install mods from Steam Workshop and GitHub instead.
-When editing your mods folder you should ALWAYS make a backup in an easy to find place (such as your desktop)in case you come across errors, this way you will always be able to undo a mistake that may occur. and it is also VERY IMPORTANT to never delete the ThingCatagories.XML file in your mod pack, doing this will result in a black screen when trying to start the game up.
-== Mod Compatibility ==
+=== Manual Installation ===
-Not all mods work with each other, you will know if you have mods that do not work if you are having serious gameplay issue, such as unplaceable items, graphical issue, colonists getting stuck etc.
-==General Modding Advice==
+You can install mods manually by unzipping them into subfolders within your local Mods folder. This location varies by operating system:
-*The tilde key (`) brings up the dev console, which will report any errors it encounters. This is the quickest way to see what, if any, errors exist in your mod.
-*Use Development Mode (Found in Options) to help debug your mod.
-==Getting started==
+{| class="wikitable" style="margin-right:auto"
-===Format of files===
+|-
-For defining new game content, '''[[wikipedia:XML|XML]]''' files are used. Here is an example of the format, that applies to most of the definitions:
+! Operating System !! Default Folder Location
-<source lang="xml">
+|-
-<?xml version="1.0" encoding="utf-8" ?>
+| Windows || <code>C:\Program Files (x86)\Steam\steamapps\common\RimWorld\Mods</code>
-<SomeDefs>
+|-
-   <SomeDef>
+| Mac || <code>Library/Application Support/Steam/steamapps/common/RimWorld</code>
-      <defName>MyNewDefinitionOfContent</defName>
+|-
-      <!-- more tags will appear depending on what are you defining -->
+| Linux (standalone) || <code>~/.steam/steam/steamapps/common/RimWorld/Mods</code>
-   </SomeDef>
+|-
-</SomeDefs>
+| Linux (GoG) || <code>/home/<user>/GOG/Games/RimWorld/game/Mods/</code>
-</source>
+|}
-Remember, that the word '''Some''' must be replaced by the name of whatever are you defining. For thing it's '''&lt;ThingDef&gt;'''.
-==Mod structure==
+=== Activating Mods ===
-The RimWorld mods use the following directory structure.
-<pre>
-┌About
-├╴About.xml (Contains info about the mod)
-├╴Preview.png (Image that appears above the mod info in game. Max width 600px.)
-│
-├Assemblies (If your mod uses any DLL files put them here)
-├╴MyMod.dll
-│
-├Defs (Contains xml definitions of the mod)
-├┬ThingDefs
-│├╴Things.xml
-│└╴Buildings.xml
-├┬ResearchProjectDefs
-│└╴MyProjects.xml
-│the folder name must be specific here. Look in Core mod to see what are other names supposed to be
-│
-├Sounds
-│
-├Source
-├╴MyMod.cs (Optionally, put the source code of your mod here)
-│
-├Strings
-│
-├Textures (Put any image textures here, preferably in .png format.)
-└┬Things
- ├╴MyMod_ImageA.png
- └╴MyMod_ImageB.png
-</pre>
-===Mod Info:===
+Once you have installed mods, you can select the '''Mods''' option from the main menu of RimWorld to activate them. Activating or deactivating mods requires RimWorld to restart.
-This is found in <code>\MODNAME\About\</code>
-*The contents of About.xml are plain text. HTML Markup tags cause NullRef's.
-*You can have an image for your mod. Restrict the image width to 600 pixels
-===Textures:===
+== Making Mods ==
-These are found in <code>\MODNAME\Textures\</code>
-*You can have any path you want from this point on.
-*When referencing textures in your mod, using <TexturePath>, have the complete path relative to your mod, including the filename (but not the file extension). Example for the RoyalBed Testmod: <code><TexturePath>Things/Building/RoyalBed</TexturePath></code>
-*You can randomize textures within a folder using a <textureFolderPath> pointing at a folder with multiple textures inside. Each Thing of the given def will have a random texture from the folder.
-===New Interactable "Things":===
-A thing is anything that exists in the game world. It includes resources, races (humanoid and animal), buildings, furniture, and many others.
-These are defined in <code>\MODNAME\Defs\ThingDefs</code>
-If you make a new workbench, you'll need to define a recipe for it. This is a list, so you can have many new recipes listed.
-The recipes themselves are defined in: <code>\MODNAME\Defs\RecipeDefs</code>
-In here you can define what ingredients/resources are required, what can be used, and what the default recipe is.
-Any new resources will need to be defined in: <code>MODNAME\Defs\ThingDefs</code>
-===New Turrets:===
-These are defined in two files in: <code>\MODNAME\Defs\ThingDefs</code>
-Buildings_Big.xml and Weapons_Guns.xml (Remember, these can be named anything)
-Buildings_Big.xml defines the structure of the turret itself. IE:
-<syntaxhighlight lang="xml" >
-<building>
-	<turretGunDef>Gun_TurretImprovised</turretGunDef>
-	<burstCooldownTicks>300</burstCooldownTicks>
-</building>
-</syntaxhighlight>
-Weapons_Gun.xml defines the weapon the turret uses. Anything can be used as a weapon for turrets, including grenades.
-===New Resources:===
-These are defined in: <code>MODNAME\Defs\ThingDefs\Resources.xml</code>
-===New Research Projects:===
-These are found in: <code>MODNAME\Defs\ResearchProjectDefs</code>
-You can have research trees as well, where additional research projects get unlocked as you move through.
-This is how to add prerequisites:
-<syntaxhighlight lang="xml" >
-<prerequisites>
-	<li>-this is the <defName> of the prerequisite-</li>
-</prerequisites>
-</syntaxhighlight>
-Because it's a list, you can have multiple prerequisites for a research project.
-== References ==
-*[http://ludeon.com/forums/index.php?topic=1681.0 forum thread]
-*[http://rimworldgame.com/publicArtSource/ThingGraphics.zip RimWorld core art source]
+Please check out the [[Modding_Tutorials|Modding Tutorials]] hub for tutorials and guides on how to create and publish your own mods.
 [[Category:Modding]]

Difference between revisions of "Modding"

Latest revision as of 17:55, 17 August 2024

Contents

Using Mods[edit]

Manual Installation[edit]

Activating Mods[edit]

Making Mods[edit]

Navigation menu

Search