Modding Tutorials/Writing custom code

From RimWorld Wiki
Revision as of 10:44, 25 August 2015 by Alistaire (talk | contribs) (Made more in line with other tutorials)
Jump to navigation Jump to search

Modding Tutorials

This page was originally created by TheTynan.

This tutorial gives you a broad idea how to work on a C# solution.

Requirements

Writing custom code

  1. Create a new class in a new code file:
    1. In your IDE project file browser, right-click (YourProjectName), Add -> New item -> C# or .NET -> Class;
    2. Rename the class to what you want the class name to be, e.g DamageWorker_FlameExtension,
  2. You’ll want to add these namespace to the top of each of your .cs source files as necessary;
    using UnityEngine;  	//For all Unity functionality, rendering, resource management
    using AI;		//RimWorld AI
    using Sound;	        //RimWorld sound subsystem
    using UI;		//RimWorld GUI
    
  3. Write your class;
    1. Decompile source code to take a look at the game's existing code;
    2. If you still get stuck on anything, any modding questions can be asked on the subforum,
  4. Compile your class into a .dll;
    1. Make sure your project's output type is "class library";
    2. Note: by default, Visual Studio will compile all the references of the project as well, so you’ll get a copy of UnityEngine.dll and Assembly-CSharp.dll and some others. You don’t need these. Just take YourModName.dll,
  5. Place the .dll in the YourModName/Assemblies folder of your mod;
  6. Reference the classes in your .dll from the xml data in the YourModName/Defs folder;
    1. Example: Create a new ThingDef with a <thingClass> that points to a class in your .dll,
  7. The game should load your class now;

See also