Mods are modifications to Dungeons of Dredmor created by the player community.

There are a few things that every mod requires.

Contents [hide]

1 Directory Structure
2 Files
2.1 XML
2.2 Sprites
2.3 Animations
2.4 SoundFX
Directory Structure

All files should be placed in the "Gaslamp Games/Dungeons of Dredmor/mods"

directory. On Windows 7, this is located in
C:\Users\%username%\Documents\Gaslamp Games\Dungeons of Dredmor\mods
On Windows XP, this is located in
C:\Documents and Settings\%username%\My Documents\Gaslamp Games\Dungeons of
Dredmor\mods
On Mac OSX, this is located in
~/Library/Application Support/Dungeons of Dredmor/mods
Inside of the mods directory, create a new directory with the name of your mod.
Using the example from How To Package a Mod, you would then create (under Windows
7) a directory structure similar to this, substituting the name of YOUR mod for the
"Dirk Diggle in the Blink Curse Trap Fiasco" below.
C:\Users\%username%\Documents\Gaslamp Games\Dungeons of Dredmor\mods\Dirk Diggle
in the Blink Curse Trap Fiasco
C:\Users\%username%\Documents\Gaslamp Games\Dungeons of Dredmor\mods\Dirk Diggle
in the Blink Curse Trap Fiasco\mod
C:\Users\%username%\Documents\Gaslamp Games\Dungeons of Dredmor\mods\Dirk Diggle
in the Blink Curse Trap Fiasco\sprites
C:\Users\%username%\Documents\Gaslamp Games\Dungeons of Dredmor\mods\Dirk Diggle
in the Blink Curse Trap Fiasco\items
C:\Users\%username%\Documents\Gaslamp Games\Dungeons of Dredmor\mods\Dirk Diggle
in the Blink Curse Trap Fiasco\soundfx
Files

XML
Dungeons of Dredmor mods are created by using Extensible Markup Language (XML)
files. The XML files all go under the /mod directory under the "Dirk Diggle in the
Blink Curse Trap Fiasco" (or otherwise named) directory that you just created. You
*must* have a file in the /mod directory called "mod.xml". You could conceivably
package a mod with just "mod.xml", but it wouldn't do much except annoy anybody
that expects it to do something :) Accordingly, you'll want to place other XML
files in the /mod directory. Here's an alphabetical list of all of the optional
files that can be placed in the /mod directory:

itemDB.xml
monDB.xml
rooms.xml
skillDB.xml
spellDB.xml

Sprites
Sprites should be .png files, due to .bmp and .jpg's lack of transparency.
Animations
Animations should be multiple .png files, and an .xml file to explain to the game
what sprite to load when, and how long.
SoundFX
Sound effects can't be used in mods as of yet.
Log inPageDiscussionReadView sourceView history