Editing Modding Tutorials/Testing mods

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
 
{{BackToTutorials}}
 
{{BackToTutorials}}
<br/>
+
{{Credit|[[User:Alistaire|Alistaire]]}}<br/>
  
 
In this tutorial we will look into testing our mods.<br/><br/>
 
In this tutorial we will look into testing our mods.<br/><br/>
Line 13: Line 13:
  
 
===Development mode===
 
===Development mode===
 +
{{main|Modding Tutorials/Development mode}}
 +
 
To use this mode, you need to activate it:<br/>
 
To use this mode, you need to activate it:<br/>
  
# Run RimWorld;
+
# Run Rimworld;
 
# Press the "Options" button in the main menu;
 
# Press the "Options" button in the main menu;
 
# Under Gameplay, the middle column, tick "Development mode".<br/><br/>
 
# Under Gameplay, the middle column, tick "Development mode".<br/><br/>
Line 22: Line 24:
  
 
# Create world;
 
# Create world;
# Create a colony;
+
# Create a colony, probably on Free Build difficulty;
 
# The following icons: [[File:DevelopmentMode.png|link=]] .. can now be found in the top-right;
 
# The following icons: [[File:DevelopmentMode.png|link=]] .. can now be found in the top-right;
 
## [[File:DebugLog.png|link=]] '''Open the debug log''' = Clicking this opens the debug log;
 
## [[File:DebugLog.png|link=]] '''Open the debug log''' = Clicking this opens the debug log;
## [[File:PackageEditor.png|link=]] '''Open the package editor''' = Opens the package editor, which allows you to preview and modify [[Modding Tutorials/Sounds|Sounds]] and Hair (Is not available for mod use as of 1.0);
+
## [[File:PackageEditor.png|link=]] '''Open the package editor''' = Opens the package editor, which allows you to preview and modify [[Modding Tutorials/Sounds|Sounds]] and Hair;
 
## [[File:ViewSettings.png|link=]] '''Open the view settings''' = Allows you to activate graphic overlays and cheats like Fast Research;
 
## [[File:ViewSettings.png|link=]] '''Open the view settings''' = Allows you to activate graphic overlays and cheats like Fast Research;
 
## [[File:Debug.png|link=]] '''Open debug actions menu''' = This menu allows you to do all sorts of things;
 
## [[File:Debug.png|link=]] '''Open debug actions menu''' = This menu allows you to do all sorts of things;
Line 38: Line 40:
 
## [[File:GodMode.png|link=]] '''Toggle god mode''' = Toggles God mode, which allows you to build things without cost;
 
## [[File:GodMode.png|link=]] '''Toggle god mode''' = Toggles God mode, which allows you to build things without cost;
 
## [[File:ErrorLog_False.png|link=]] '''Pause the game when an error is logged''' = Toggles exactly what it says.<br/><br/>
 
## [[File:ErrorLog_False.png|link=]] '''Pause the game when an error is logged''' = Toggles exactly what it says.<br/><br/>
 
===Using Debugger===
 
Code of RimWorld is run and supported by a Mono runtime. A modified version of Mono is used by Unity that RimWorld builds on. Its repository can be found here: https://github.com/thardie/mono.
 
 
A step by step tutorial is available at https://github.com/Mhburg/AwsomeInventory/wiki/How-to-debug-RimWorld-from-Visual-Studio
 
 
Brrainz is working on a source level debugging tool for Rimworld Modding available at https://github.com/pardeike/RimWorld4Debugging
 
  
 
=Testing specific content=
 
=Testing specific content=
Line 64: Line 59:
 
===Incidents===
 
===Incidents===
  
Incident mods can be tested using Debug Actions Menu -> Incidents. To get a sense for the regular threat scale and other data like the population intent: View settings -> Write storyteller. You'll find the data output in the Debug inspector (magnifying glass).<br/><br/>
+
Incident mods can be tested using Debug Actions Menu -> Incidents.<br/><br/>
 
 
===Jobs===
 
 
 
You can toggle job logging by using Actions Menu -> Tools - Pawns -> Toggle job logging. Note that this doesn't log all JobGivers, only if they return a job. Some Jobgivers may still do something without returning a job. Looking at you, JobGiver_DropUnusedInventory, Ruiner of Sleep and Waster of Hours. Also useful: View settings -> Draw Pawn Debug (for seeing destinations/reservations).<br/><br/>
 
 
 
===Lords===
 
 
 
* View settings -> Draw Duties (for seeing what each pawn does)
 
* View settings -> Draw Lords (for seeing what the Lord does)
 
* View settings -> Log Lord Toil Transitions (for reading what transitions happen)<br/><br/>
 
 
 
=Tips for testing=
 
Read the README.txt.
 
 
 
==Quickstart==
 
For testing, you can start the game into a tiny (fast-loading) map with one click by running the game with the -quicktest command line parameter. For example:
 
 
 
        C:/RimWorld/RimWorld.exe -quicktest
 
 
 
or on Mac
 
 
 
        /Users/Username/Library/Application\ Support/Steam/SteamApps/common/RimWorld/RimWorldMac.app/Contents/MacOS/RimWorldMac -quicktest
 
 
 
You can make a shortcut to the game which does this.
 
 
 
If a savefile called autostart.rws is present, the game will load that.
 
 
 
==Save data==
 
You can override the save data folder. This is useful, for example, if you want to install the game on a USB stick so you can plug and play it from anywhere.
 
To do this, add this to the end of the command line used to launch the game:
 
 
 
        -savedatafolder=C:/Path/To/The/Folder
 
 
 
So it'll look something like this:
 
 
 
        C:/RimWorld/RimWorld.exe -savedatafolder=C:/Path/To/The/Folder
 
 
 
If you don't start the path with anything, it'll be relative to the game's root folder. So you could do this, to have the game save data in a folder called SaveData in its own root folder:
 
 
 
        -savedatafolder=SaveData
 
 
 
Be sure the game is running with permission to modify the folder. It may not work properly if, for example, you run the game under default permissions on its own install folder.
 
 
 
You can combine the -savedatafolder with the -quicktest argument for a clean modding environment.
 
 
 
==Mod tools==
 
There are mods which can make testing and modding in general easier. As of 1.0, the most well-known is probably [https://github.com/UnlimitedHugs/RimworldHugsLib/ HugsLib]. It offers a more elaborate quick-start function, and a configurable hotkey to restart the game. Other mods are [https://github.com/Jaxe-Dev/PublisherPlus Publisher Plus by Jaxe], [https://github.com/alextd/RimWorld-TDBug TDBug by AlexTD/Uuugggg] and [https://github.com/RimWorld-CCL-Reborn/4M-Mehni-s-Misc-Modifications/ 4M Mehni's Misc Modifications by Mehni]. If that isn't enough, write your own tool! The most useful tools are those that give you info about how the game works.
 
 
 
  
 
[[Category:Modding tutorials]]
 
[[Category:Modding tutorials]]

Please note that all contributions to RimWorld Wiki are considered to be released under the CC BY-SA 3.0 (see RimWorld Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)

Template used on this page: