Modding Guide

What Are Mods?

Mods are a way of adding or changing game data. This includes overriding existing data and adding new data to change various aspects of the game such as a new language translation. Mercury Fallen data is defined using XML files.

Mod Structure

A mod must be contained in it’s own folder. In the root of this folder resides the modinfo.xml file and preview.jpg. Xml files that modify or add game data must be in a sub-folder.

Sub folders containing your mod data files do not require any specific naming convention. When a mod is enabled the game will search all sub folders inside a mods main folder for xml data.

The mod preview image is required if submitting your mod to the Steam Workshop. 256×256 pixel size is recommended.

Mod Info File

A modinfo.xml file must be in the root of your mod folder. This defines your mod and is required for your mod to load and be visible in the mod manager.

<ModInfo>	
	<Name>Generator Mod</Name>
	<Author>So &amp; So</Author>
	<URL>http://wwww.website.com</URL>
	<Version>1.0</Version>
	<Summary>Increases Output of Coal Generator</Summary>
</ModInfo>

Name
This is the display name that will appear in the mod manager list inside the game

Author
This is you. Add your name or call sign here. This is visible in the mod manager.

URL
A link to your website or page regarding this mod or your mods.

Version
A description of your mods version. Version info is up to you, but should reflect the current state of the mod and be changed as you update your mod.

Summary
A description of what your mod does.

Steam Workshop

The Steam Workshop is a the place to find new translations and game tweak mods. While browsing the Workshop subscribe to any mod that you want to use in your game. Steam will download and install the mod for you. Please see the enabling mods section for details on how to enable your mod after it is installed.

Installing Mods Manually

A mod folder should be placed inside the Mercury Fallen UserMods folder.

Windows
<Documents>/Mercury Fallen/UserMods/

Mac
/Users/<yourusername>/Mercury Fallen/UserMods

Enabling Mods

Once a mod has been installed from the Workshop or manually it will need to be enabled in game. On the Main Menu click on Mods to open the Mod Manager. The mod should appear in the mod list. Click the toggle next to the mod to enable it and click the close button. The mod is now enabled and loaded.

Core Content

When making a mod you will often be overriding XML data defined by the core content of the game. Follow the instructions below to reach the location of the core game files.

  1. Right click Mercury Fallen in your Steam Library and click Properties
  2. Click the Local Files tab
  3. Click the Browse Local Files… button. This will open the local game folder for Mercury Fallen.
  4. The core game files are located under MercuryFallen_Data/Mods/Core

The game data files are organized into various folders. This is a good place to get started to see how data is defined in the game.