Editing Modding Tutorials/Recommended software

{{DISPLAYTITLE:Recommended Software}}

{{BackToTutorials}}

This is a short list of programs that are useful for making mods. Most of the options listed here are free, but if you have development experience and have a favorite IDE, then by all means use what you're familiar and/or comfortable with!

=XML Editors=

While XML files are simple text files, basic Windows Notepad lacks any kind of syntax highlighting and rich text editors such as WordPad will insert invisible characters that are not recommended for machine-readable data files. The following are basic code editors that are recommended for writing or editing XML files:

{| class="wikitable"
! Software !! OS !! Description
|-
| [http://notepad-plus-plus.org/download/ Notepad++] || Windows || Light-weight editor with extension support. Adding the "XML Tools" plugin is recommended for editing XML files, as it adds additional validation and error-checking.
|-
| [https://code.visualstudio.com/ Visual Studio Code] || Linux/Windows/Mac || A text editor with emphasis on productivity and extension support. Also has an excellent XML plugin.
|-
| [http://www.sublimetext.com/ Sublime Text] || Linux/Windows/Mac || Natively supports many programming languages and markup languages, and its functionality can be extended by users with plugins - A brief overview of its functionality can be found [http://webdesign.tutsplus.com/tutorials/useful-shortcuts-for-a-faster-workflow-in-sublime-text-3--cms-22185 here] and a full course [http://code.tutsplus.com/courses/perfect-workflow-in-sublime-text-2 here]
|-
| [http://xmlnotepad.codeplex.com/releases/ XML Notepad] || Windows || XML-oriented editor with a lot of features you will most likely never use in Rimworld modding
|-
| [http://www.geany.org/ Geany] || Linux/Windows/Mac || Extremely lightweight text editor with syntax highlighting and some other basic features oriented towards XML and code editing.
|}<br/>

=IDEs=

Writing C# code for custom assemblies requires not only code editing capability but also the ability to compile raw code into executable code. This is generally best done in an Integrated Development Environment that has a compiler built-in.

{| class="wikitable"
! Software !! OS !! Description
|-
| [http://www.visualstudio.com/ Visual Studio] || Windows/Mac || Microsoft's flagship IDE and strongly recommended if you are running Windows. The [https://www.visualstudio.com/products/visual-studio-community-vs Community Edition] is free for individuals and small teams, and does everything you need to make a RimWorld mod assembly out of the box.
|-
| [http://www.icsharpcode.net/OpenSource/SD/Download/ SharpDevelop] || Windows || Free IDE specifically made for C#
|-
| [https://www.jetbrains.com/rider/ Rider] || Windows/Mac/Linux|| Unless you're a student it costs, but offers a lot of tools across all platforms.
|}

Whichever IDE you choose, make sure it's capable of compiling for .NET Framework 4.7.2. If you for whatever reason don't have this framework installed, you can download it [https://dotnet.microsoft.com/download/dotnet-framework/net472 here].

=C# Decompilers=

''See [[Modding_Tutorials/Decompiling_source_code|Decompiling source code]]''

=Graphics Software=

For making textures you will need graphics software. Any image editing program should work, and if you have an alternative to the following links that's probably okay:<br/>

{| class="wikitable"
! Software !! OS !! Description
|-
| [http://www.photofiltre-studio.com/download-en.htm Photofiltre Studio] || Windows || Functional software with very little user interface clutter for its applications. Doesn't support pen tablet, and has a 100% free (non-trial) version called [http://photofiltre.free.fr/download_en.htm Photofiltre]
|-
| [http://inkscape.org/en/download/ Inkscape] || Linux/Windows/Mac || Free vector graphic program with a steeper learning curve due to the vector based image editing. Vector graphics can look better than bitmap graphics in Rimworld
|-
| [http://www.photoshop.com/products Photoshop] || Windows/Mac || Paid software with a trial version. Rimworld's original graphics are made in Photoshop (they're .PSD files)
|-
| [http://www.gimp.org/ GIMP] || Linux/Windows/Mac || A free, open-source alternative to Photoshop that's been around since 1998. GIMP has a large user community, with great list of [http://www.gimp.org/tutorials/ tutorials] on the official sites
|-
| [https://krita.org/en/homepage/ Krita] || Linux/Windows/Mac || A free digital painting software. Better suited than GIMP for painting and should feel like home pretty quick for Photoshop users.
|}<br/><br/>

=Audio Software=

Recording your own audio for mods might be too much to ask, but editing audio is always possible. This can be done with the following software or your own alternative:<br/>

{| class="wikitable"
! Software !! OS !! Description
|-
| [http://sourceforge.net/projects/audacity/ Audacity] || Linux/Windows/Mac || Audio editing software with many tutorials online, lots of useful functionality and a relatively readable interface
|}<br/><br/>

=Next up=

# [[Modding Tutorials/XML file structure|XML File Structure]] starts you off with the XML side of modding.
# [[Modding_Tutorials/Setting up a solution|Setting up]] starts you off with the C# side of modding. Knowledge of the XML part can and will be very useful.<br/>


[[Category:Modding tutorials]]