The mod.xml File - dredmor-com/dungeons-of-dredmor GitHub Wiki

As mentioned, for a mod to be considered "valid", it needs a mod.xml file with properly structured information about the mod. This includes mods that contain items, skills, rooms, monsters or a combination of these and more.

In most cases, your mod.xml file should look like this:

<dredmormod>
    <revision text="1.0"/>
    <author text="Your Name Here"/>
    <name text="Your Mod's Name Here"/>
    <description text="A short description of your mod"/>
    <info totalconversion="0"/>
    <require expansion="1"/>  <--- Optional
</dredmormod>

Up next is an explanation of what each tag or component does. Most of these are necessary for a valid mod of any kind.

1. 'dredmormod': This tag is needed for Dungeons of Dredmor to load information and to validate it as a mod. Anything between the opening and closing tags is data regarding the nature of your mod.
2. 'revision': A tag for versioning, useful for updates and keeping track of changes. Its 'text' attribute contains the version of your mod, which would be 1.0 in our example.
3. 'author': A tag to identify who made the mod, whom might be you! Its 'text' attribute is a string that should contain the name. In our case, "Your Name Here". You can replace this with your name.
4. 'name': The name of your mod. Its 'text' attribute will be what your mod will be known as on the mod loader. It's also important for the first impression of your mod to a fellow player!
5. 'description': What it says on the tin, it should be a succint, concise description of what this mod includes. It all should go on its 'text' attribute.
6. 'info': Miscellanous information for the mod loader and game engine. Its 'totalconversion' attribute, a boolean, tells the game if your mod changes aspects of the base game and/or its DLC content. In our case, we place '0' to tell it we're not changing the fundamentals. As of now, this tag is non-functional.
7. 'require': An entirely optional tag that describes if you need information from any of the DLC packs, also called expansions. With the 'expansion' attribute, you can tell the game which specific pack you need. In our case, we place '1' to tell it we need material from the "Realm of the Diggle Gods" expansion, like an image, file or spell. Below is a table of all the available values: