mod.xml

Parent Previous Next

The mod.xml contains information about the mod. Not only does it show up in the SDX Launcher, but will also show up in some of the support tools we are rolling out.


<mod>

       <info>

               <!-- Information about the Mod, the author and version information -->

               <!-- These are displayed in the SDX Launcher -->

               <author>sphereii</author>

               <name>Bigger Back Pack</name>

               <description>Bigger Back Pack SDX Mod 5x9 45</description>

               <mod_version>1.0</mod_version>

               <game_version>16.2</game_version>

               <launcher_version>0.0.0</launcher_version>

               <type>Mod</type>

       </info>

       

       <!-- This references any config files that SDX needs to merge into your files -->

       <config_mods>

               <import file="Config\BiggerBackPack.xml" />

   </config_mods>

       

</mod>>


Author: The one who wrote or put together the mod

Name: The unique name for the Mod. This shows up in the SDX Launcher.

Description: Short description of the Mod

Mod Version: The version number here is in a Major.Minor example.


   If your mod is relatively small, it is recommended to use a two digit version system.

       Major: Complete overhaul, such as going from Alpha 15 to Alpha 16.

       Minor: Minor tweaks, such as going from Alpha 16.2 or Alpha 16.3, and for bug fixes as well.


   For larger, more comphrensive Mods, or if you would like more fine tuning of a version, you may opt to do a Major.Minor.Defect.

       Major: Complete overhaul, such as going from Alpha 15 to Alpha 16.

       Minor: Minor Tweaks, such as going from Alpha 16.2 to Alpha 16.3

       Defect: Bug fixes


game_version: The latest version of the Game which the mod was tested and found to be working.

launcher_version: Which version of SDX Launcher it is compatible. ( Optional )

type: The type of mod package you have:


       

Type Value

Description

Mod

A full integrated Mod, maybe include XML, Assets and code.

Sample

A small mod used for demonstration, as opposed to a real mod.

AssetBundle

A mod with just a Unity Asset Bundle, to introduce new textures and sounds.

XML

A mod with only XML changes

QoL

Quality of Life Improvement. Does not add new items or recipes, but rather just makes the game run better.

Icons

A mod that contains just Icons

Overhaul

A Complete Overhaul Mod, includes many assets and changes.

Expansion

A Complete Expansion; adding new recipes items, but keeping with the spirit of Vanilla



Created with the Personal Edition of HelpNDoc: Easily create PDF Help documents