Skip to content

Mod Metadata File

Tahvohck edited this page Mar 18, 2021 · 2 revisions

Overview

This file, named info.xml and placed in the top-level directory of your mod, controls the mod's meta-information. It is REQUIRED for a mod to work.
It starts with a <mod> tag and can specify the following information:

Tag Description Required?
<name> Displayed name of your mod, shown in the modloader sidebar. Yes
<description> Description, shown in the main window of the modloader. Yes
<minimumLoaderVersion> The minimum modloader version needed for the mod to work properly. Yes
<gameVersions> A list of game versions the mod officially supports. No
<version> The mod version, in format Major.Minor.Patch No
<author> You! (Probably) No
<website> The homepage for your mod. May be used for auto-updates later. No
<knownIssues> Any issues you know the mod has. No
<updates> Currently unused. No
<modID> A numerical identifier for the mod.
This will be used in some places automatically by the loader.
No

Example

<mod>
    <name>Tahvohck-tweaks</name>
    <description>Various tweaks
Description can be multiple lines, but keep in mind that spaces on the start of the line are included!
    </description>
    <minimumLoaderVersion>0.8.1</minimumLoaderVersion>
    <gameVersions>
        <v>0.10.2</v>
    </gameVersions>
    <version>1.0.5</version>
    <modid>28413</modid>
    <author>Tahvohck</author>
    <website>https://github.com/Tahvohck/spacehaven-TahvTweaks</website>
</mod>

Clone this wiki locally