Configuring XML Files

This guide will get you started with editing the XML files.

Most of the Mars Simulation Project’s configuration files are primarily written in XML format. Some are in JSON.

At the beginning of a sim (whether it is starting a brand new sim, or loading from a new sim), the values/attributes/properties contained in these xml files will be read into your local machine’s Java VM memory.

Most attributes and properties are designed to tolerate a range of values. However, they are not all created equal to have the same degree of user customization.

Note that when saving a sim, it will not alter any XML files.

Location

At startup, they are being copied into user’s home directory. Players may manipulate these XML files in /.mars-sim/xml folder. The file can be editted in this location but changes will be overwritten when a new simulation starts unless the file name is added to the exception.txt file.

Backup

It is recommended that you make a backup of the original xml configuration file before editing them as edited XML files often contain errors that may result in a failure for mars-sim to boot up.

Whenever a new build or version of mars-sim is executed, it will attempt to compare the version content of the version.txt file in the /.mars-sim/xml folder to determine if it matches the core engine’s build version.

If they don’t match, mars-sim will attempt to backup the existing XML files on user home into a new directory inside the backup folder.

List of XML files