Modding Tutorials/Recommended software

From RimWorld Wiki
Revision as of 15:33, 12 July 2015 by Alistaire (talk | contribs) (→‎C# Code Editors: Changed title to IDE's)
Jump to navigation Jump to search

What you'll learn

This tutorial lists a few programs you could use to edit XML and C# code.

XML Code Editors

Basic Editors

Just about any text editor can write XML code, but as a modder you will want to at the very least see when you forgot closing brackets, a closing tag and other syntax errors.

Notepad doesn't do this, so if you're even somewhat serious about modding, the following software will help you immensely:

  • Notepad++ = Has well implemented auto-completion and a very customizable user interface. Can be used to write both XML and C# code, although C# software usually has its own text editor;
  • Programmer's Notepad = More lightweight with a less cluttered interface than Notepad++, also capable of editing both XML and C# code;
  • XML Notepad = XML-oriented editor with a lot of features you will most likely never use in Rimworld modding.

Advanced Editors

There's many editors out there specifically made for XML code. Because Rimworld uses XML in a very simple way, advanced code editors are rarely needed. In case you're ever in need of one, however, the following ones might help:

  • XPontus = Has a tree view and is capable of checking XML for errors, fixing tabs and creating schema's detailing every tag's data types;
  • XMLGrid = Capable of validating XML and turning it into Excel Spreadsheets, XSD Charts and an online table detailing each tag of a certain type and its contents.

IDE's

C# code is best edited in an IDE (Integrated Development Environment) to make the process of editing code, managing a solution's content and compiling its projects both easier and faster. Any IDE for C# will probably work just fine, so here's a list of suggested editors:

  • Visual Studio = Very extensive IDE with paid, trial and free versions. Any of these versions will work, so you might as well take the latest free version;
  • MonoDevelop = Free, cross-platform IDE with customizable user interface. Has support for C# as well as some other languages you won't need for Rimworld;
  • SharpDevelop = Free IDE specifically made for C#.

Whichever IDE you choose, make sure it's capable of compiling for .NET Framework 3.5. If you for whatever reason don't have this framework installed, you can download it here.