Custom Data Files

Modified on 2013/01/20 22:58 by Keith Rudolph — Categorized as: Chummer SR4 - Data Files

Players and GMs can enter custom data by creating Custom Data Files. Each Data File can have a number of separate Custom Data File. Custom Data Files must start with custom and and with _[datafile].xml. For example, to create custom data for Cyberware, you could name your new file custom_cyberware.xml or custom_StuffFromOtherUsers_cyberware.xml. Custom Data can be spread across multiple Custom Data Files as long as they follow this file naming convention. These files must be placed in Chummer's data directory along with the existing Data Files. Custom Data Files should be saved with UTF-8 encoding.

Override Data Files

Similar to Custom Data Files, you can create Override Data Files which override the content in Chummer's base data files. This is useful for changing the BP value of Qualities or changing the bonus information for any item. Override Data Files must start with override and and with _[datafile].xml. For example, to create override data for Cyberware, you could name your new file override_cyberware.xml or override_StuffFromOtherUsers_cyberware.xml. Override Data can be spread across multiple Override Data Files as long as they follow this file naming convention. These files must be placed in Chummer's data directory along with the existing Data Files. Override Data Files should be saved with UTF-8 encoding. The XML data in the override file completely replaces the matching item in the base data file, so it is recommended you copy the XML from the base data file into your override file then make the desired changes.

Custom Data File Structure

All Custom Data Files must follow the same structure as the base Data Files and begin and end with the <chummer> tag. See the description of each Data File for specific information on each file.

The easiest way to start a new Custom Data File is to copy the existing base Data File. The <version> tag can be safely removed from your new file. Your Custom Data File should only contain information that is not already in the base Data File. If duplicate items exist, the information in the base Data File will be used.

Make sure your Custom Data File is 100% valid and properly formatted before attempting to use it with Chummer. Invalid/improperly formatted files that cannot be read will cause Chummer to crash.

Chummer XSD Files

The contents of your Custom Data Files can be validated by using the Chummer XSD files. These are the same files that are used to validate the content of Chummer's core Data Files. The XSD files package also contains the XSD for working with Chummer's save files for external applications. Download the Chummer XSD files (updated January 20, 2013).