Difference between revisions of "Modding"

Latest revision as of 08:05, 24 October 2023

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 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.

Difference between revisions of "Modding"

Latest revision as of 08:05, 24 October 2023

Contents

Using Mods[edit]

Manual Installation[edit]

Activating Mods[edit]

Making Mods[edit]

Navigation menu

Search

@@ Line 3: / Line 3: @@
 | {{Basics_Nav}}
 |}
-<hr>
+----
-{{See also|List of mods}}
+'''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.
-'''Mods''' (short for modifications) are small packages that add to or otherwise affect gameplay in RimWorld. They include art packs (for reskinning the game), more weapons, more incidents, furniture, and game-balancing mods.
-This page is about making mods. For info about using mods, see [[Installing mods]].
+== Using Mods ==
-==Mod-making tutorials==
+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.
-Mod-making tutorials are available at the [[Modding Tutorials]] page. If you can't find what you need, you should try looking in [[Modding/Random Bits of Information|Random Bits of Information]] to check if the information you're looking for has been found but just hasn't been organized into the correct article yet.
-===Mod-making Templates===
+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] to download and install mods from Steam Workshop and GitHub instead.
-*[https://ludeon.com/forums/index.php?topic=39038.0 Mod Development Cookiecutter (automatically build your mod development environment)]
-==What you can mod==
+=== Manual Installation ===
-You can mod defs, code, images, and sounds.
-* '''Defs''': XML files containing lists of definitions for use by the game. There are a lot of these. They define every thing, skills, storyteller, and many other types of data. Find them in YourModName/Defs. More about this later.
+You can install mods manually by unzipping them into subfolders within your local Mods folder. This location varies by operating system:
-* '''Code''': You can add .NET assemblies and the game will load them. Place your DLLs in YourModName/Assemblies. More about this later.
-* '''Images''': You can add images.
-* '''Sounds''': You can add sound files.
-* '''Jobs''':  A useful link here https://github.com/Mehni/ExampleJob/wiki - covers JobGivers WorkGivers and Toils
-** Higher level, explanation on how pawns think:  https://github.com/roxxploxx/RimWorldModGuide/wiki/SHORTTUTORIAL%3A-How-Pawns-Think
-==The basics: Defs==
+{| class="wikitable" style="margin-right:auto"
-The most basic kind of RimWorld modding is done by editing '''defs'''.
+|-
+! Operating System !! Default Folder Location
+|-
+| Windows || <code>C:\Program Files (x86)\Steam\steamapps\common\RimWorld\Mods</code>
+|-
+| Mac || <code>Library/Application Support/Steam/steamapps/common/RimWorld</code>
+|-
+| Linux (standalone) || <code>~/.steam/steam/steamapps/common/RimWorld/Mods</code>
+|-
+| Linux (GoG) || <code>/home/<user>/GOG/Games/RimWorld/game/Mods/</code>
+|}
-Definitions each define some piece of the game. Different kinds of definitions can define:
+=== Activating Mods ===
-* '''Sound'''
+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.
-* '''Weapons'''
-* '''Buildings'''
-* '''Plants'''
-* '''Animals'''
-* '''More (To be determined)'''
-When the game runs, it collects all the definitions into pools. It then semi-randomly draws from these pools in various circumstances. It will randomly draw guns of a certain category to arm a new enemy mercenary. Or, it will randomly spawn an animal type on the edge of the map. Modding the game means adding your definitions to these pools and watching the game use them in this way.
+== Making Mods ==
-Definitions are organized into packages. Each package is saved as a single XML file.
+Please check out the [[Modding_Tutorials|Modding Tutorials]] hub for tutorials and guides on how to create and publish your own mods.
-Groups of packages are organized into mods. A mod is a unit of interlinked functionality and content. It could be a pack of new weapons, a new animal, or a total conversion of the game. A mod will usually contain several packages of various types, as well as content like images and sounds.
-The base game is defined in a single mod called Core.
-Players can choose which mods to activate. In some cases, several mods can be active at once. You could use a medieval mod to replace the core mod, and add on a weapons pack created by someone else. The game will run with the medieval mod content, and also randomly spawn in weapons from the extra weapons pack.
-==Mod file structure==
-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:
-<source lang="xml">
-<?xml version="1.0" encoding="utf-8" ?>
-<SomeDefs>
-   <SomeDef>
-      <defName>MyNewDefinitionOfContent</defName>
-      <!-- more tags will appear depending on what are you defining -->
-   </SomeDef>
-</SomeDefs>
-</source>
-Remember, that the word '''Some''' must be replaced by the name of whatever are you defining. For thing it's '''&lt;ThingDef&gt;'''.
-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)
-│
-├Patches
-├─Patch.xml
-│
-├Languages
-├┬English (Replace with the language name)
-│├┬Keyed
-││└─Keys.xml
-│├┬Strings
-││└┬Names
-││  └─PawnNames.xml
-│├┬DefInjected
-││└┬ThingDef
-││  └─Thing.xml
-│├─LanguageInfo.xml
-│└─LangIcon.png
-│
-├Textures (Put any image textures here, preferably in .png format.)
-├┬Things
-│├─MyMod_ImageA.png
-│└─MyMod_ImageB.png
-</pre>
-===Mod info===
-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===
-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 <graphicPath>, have the complete path relative to your mod, including the filename (but not the file extension). Example for the RoyalBed Testmod: <code><graphicPath>Things/Building/RoyalBed</graphicPath></code>
-For textures that have multiple faces, like animals and furniture which can be rotated; You can use the Graphic_multi class. Immediately following your <graphicPath></graphicPath>. Your Path should point to the folder containing the different textures: Texturename_east (for both east- and west-facing), Texturename_south (front-facing), and Texturename_north (back-facing).
-<source lang="xml" >
-<graphicPath>Things/Buildings/RoyalCouch/RoyalCouch</graphicPath>
-<graphicClass>Graphic_multi</graphicClass>
-</source>
-Inside your folder:
-<pre>
-┌Textures
-└┬Things
- └┬Buildings
-  └┬RoyalCouch
-   ├╴RoyalCouch_east
-   ├╴RoyalCouch_south
-   └╴RoyalCouch_north
-</pre>
-For plant textures that have multiple growth stages and/or utilize the Graphic_Random class, the different images for each stage must be in separate folders. These images within must also share the same filenames. For example, the [[corn plant]] has one immature form, and two different mature forms that appear at random once the plant is fully grown. Similarly to Graphic_Multi, when using the Graphic_Random class, you will always want to reference the folder containing the images rather than the images themselves. It should be noted that only harvestable plants are able to display an immature image.
-An example of how retexturing a plant could work:
-<source lang="xml" >
-<graphicPath>Things/Plants/CornPlant</graphicPath>
-<graphicClass>Graphic_Random</graphicClass>
-</source>
-Your folder structure:
-<pre>
-┌Textures
-└┬Things
- └┬Plants
-  └┬CornPlant
-   ├╴CornPlant_A
-   └╴CornPlant_B
-  └┬CornPlant_Immature
-   ├╴CornPlant_A
-   └╴CornPlant_B
-</pre>
-Even though there is only one image used for the immature corn plant, we must have two copies of it with the same filenames as the mature plant images in order to prevent broken textures in-game.
-If you wanted to add a leafless variant to a plant (such as the leafless trees in winter), another folder would be added.
-<pre>
-┌Textures
-└┬Things
- └┬Plants
-  └┬CornPlant
-   ├╴CornPlant_A
-   └╴CornPlant_B
-  └┬CornPlant_Immature
-   ├╴CornPlant_A
-   └╴CornPlant_B
-  └┬CornPlant_Leafless
-   ├╴CornPlant_A
-   └╴CornPlant_B
-</pre>
-===Interactive "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>
-===Turrets===
-These are defined in two files in: <code>MODNAME/Defs/ThingDefs/Buildings_Big.xml</code> and <code>Weapons_Guns.xml</code> (Remember, these can be named anything)
-Buildings_Big.xml defines the structure of the turret itself. For example:
-<source lang="xml" >
-<building>
-	<turretGunDef>Gun_TurretImprovised</turretGunDef>
-	<burstCooldownTicks>300</burstCooldownTicks>
-</building>
-</source>
-Weapons_Gun.xml defines the weapon the turret uses. Anything can be used as a weapon for turrets, including grenades.
-===Resources===
-These are defined in: <code>MODNAME/Defs/ThingDefs/Resources.xml</code>
-===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:
-<source lang="xml" >
-<prerequisites>
-	<li>-this is the <defName> of the prerequisite-</li>
-</prerequisites>
-</source>
-Because it's a list, you can have multiple prerequisites for a research project.
-==Advice==
-*The tilde key (` or ~) brings up the development console, which will report any errors or warnings it encounters when a mod loads or during gameplay. This is the quickest way to see what, if any, errors exist in your mod. (You don't need to turn on development mode for this.)
-*Use development mode (found in the options menu) to help debug your mod, spawn items related to your mod, or fire incidents at will. (Or just mess around, if you'd like.)
-==I want my mod to...:==
-'''Or, how do I make my mod do ''this''?'''
-You can find links to tutorials on the [[Modding Tutorials]] page. There's also more tutorials about the basics there, so don't miss out on that.
-* Save/Load information.  See a very useful guide at [https://spdskatr.github.io/RWModdingResources/saving-guide this page]
-* Add a new value to a def
-** See [[Custom Comp Classes]]
-** Also might be helpful: [https://ludeon.com/forums/index.php?topic=46351.0 Mod Extensions]
-== References ==
-*[https://github.com/roxxploxx/RimWorldModGuide/wiki A good guide to assist people trying to mod RimWorld]
-*[https://ludeon.com/forums/index.php?topic=39038.0 Mod Development Cookiecutter (automatically build your mod development environment)]
-*[http://ludeon.com/forums/index.php?topic=1681.0 Simple tutorial forum thread]
-*[https://ludeon.com/forums/index.php?topic=2325.0 RimWorld core art source thread]
-== Notes ==
-*You can have as many mods as you like, however too many mods may affect performance.
-*If the game crashes due to a mod-related reason on startup, or mods conflict with each other, then the game will reset the mods.
-*Mods for previous versions may be usable, however most of the time they are not compatible.
 [[Category:Modding]]