Modding Tutorials/Testing mods

From RimWorld Wiki
Revision as of 10:33, 25 August 2015 by Alistaire (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Modding Tutorials
This page was originally created by Alistaire.

In this tutorial we will look into testing our mods.

What you'll learn

You'll learn several methods to test your mods.

Debug modes

While testing your mods you might want to spawn in weapons, activate events or damage colonists, etcetera. This can be achieved using the game's Development mode.

Development mode

To use this mode, you need to activate it:

  1. Run Rimworld;
  2. Press the "Options" button in the main menu;
  3. Under Gameplay, the middle column, tick "Development mode".

Now that Development mode is activated, create a new world and colony and test your mod:

  1. Create world;
  2. Create a colony, probably on Free Build difficulty;
  3. The following icons: DevelopmentMode.png .. can now be found in the top-right;
    1. DebugLog.png Open the debug log = Clicking this opens the debug log;
    2. PackageEditor.png Open the package editor = Opens the package editor, which allows you to preview and modify Sounds and Hair;
    3. ViewSettings.png Open the view settings = Allows you to activate graphic overlays and cheats like Fast Research;
    4. Debug.png Open debug actions menu = This menu allows you to do all sorts of things;
      1. Incidents allows you to spawn in raids or execute incidents;
      2. Actions - Misc contains a few buttons that complete research, continue the in-game tutorial, etcetera;
      3. Tools - General contains explosions and damaging things, snow actions, plant growth and some more advanced AI visualizations;
      4. Tools - Pawns holds tools which alter Pawn appearance, levels, health and jobs;
      5. Tools - Spawning allows you to spawn Pawns, Items in different stack sizes, Terrain and Filth;
      6. Autotests contains some stress tests like spawning in an entire colony in different stages, burning everything and killing lots of pawns at once.
    5. Debug.png Open debug logging menu = Contains buttons which log parts of the game in the Debug Log;
    6. Inspector.png Open the inspector = Gives a lot more information when hovering over things;
    7. GodMode.png Toggle god mode = Toggles God mode, which allows you to build things without cost;
    8. ErrorLog False.png Pause the game when an error is logged = Toggles exactly what it says.

Testing specific content

Equipment

To test guns you'll want to enable Development mode and spawn in the guns you want to test using Debug Actions Menu -> Tools - Spawning -> Spawn weapons.

Apparel works in the same way, but you don't spawn it in via Spawn weapons.

Animals

Once again, using Development mode spawn in pawns using Tools - Spawning -> Spawn pawns.

Raiders

If your mod adds new weapons, you'll want to see how often raiders spawn with them. Start a raid using the Debug Actions Menu -> Incidents.

Incidents

Incident mods can be tested using Debug Actions Menu -> Incidents.