FOMS:Templates
From SingularityShift
A FOMS or Fallout Mod Sorter template is just a simple XML file with a basic structure like this:
- Example:
<?xml version="1.0" encoding="iso-8859-1"?> <mods created="20090207222923" type="template" format="1"> <mod id="Mod1.esm" /> <mod id="Mod2.esm.esm" /> </mods>
Of course, it supports everything XML does, like comments, unknown subnodes (store whatever information you'd like, FOMS will skip over it so it won't affect anything), etc.
The order that the mods are listed in the template will be the same order they are accessed in any operations (such as sorting a load order).
Contents |
[edit] The <mods> node
Every template needs a <mods> node. This is the root node that contains the child <mod> nodes.
[edit] Attributes
You can define attributes for the root <mods> node but they don't serve much purpose yet. They are as follows:
- created
- A timestamp (yyyymmddhhmmss) when the template file was created. This is for reference only.
- type
- A note about what the template is for. This will usually be something like "template" (duh) or "backup"
- format
- The format is an arbitrary integer set by the function that created the XML document. If the format of the XML document changes, this number will be incremented, and old numbers are not guaranteed to work.
- Example:
<mods created="20090207222923" type="template" format="1">[edit] Sub-nodes
- mod
[edit] The <mod> node
Each <mod> node falls below the parent <mods> node. Each mod in the template must be inside of its own <mod> node. The <mod> node doesn't need any content, but it requires at least one attribute such as id.
- Example:
<mods> <mod id="Mod1.esm" /> <mod id="Mod2.esm" /> <mod id="Mod3.esm" /> </mods>
[edit] Attributes
- id
- The filename of the mod relative to the data directory
- title
- The title of the mod (optional). It isn't really used for anything at the moment
- outdated ; If outdated is set to 1, the mod is considered obsolete
[edit] Sub-nodes
- messages
- conflicts
- dependencies
- changes
