About this mod
More then a Mod; this is a guide on how make a Mod compatible with the internal system of DD, making possible to use multiple mods without messing with the files of the Game.
- Permissions and credits
I hope others in this community can be helped to improve their mods with this guide (BTW i'm using GOG install build 21142).
Introduction:
Turns out the answer was in front of me all the time but hidden in plain sight; the guide of Steam for making mods of DD have the steps but not explain how making one manually. I'm gonna use my mod as example:
This is a simple mod for ease the beginning of the game :
- Start the game with 2 torches and 1 Skeleton Key so you can open the first chest (AKA Trolling chest).
- Remove "Kleptomaniac" from the initial crusader (because screw that quirk).
- Be able to buy firewood from the provisions store, it cost 1250 gold with a sell price of 125 gold (making it a conscious choice). Provisions available to buy before embark: Short 1, Medium 2, Long 3, Longest 4.
Process:
The first step is going inside Darkest Dungeon/mods/ and create the Mod Folder Name , in this case will look like this
Darkest Dungeon/mods/(Mod Folder Name)--->Darkest Dungeon/mods/Beginner Mod Pack
Inside put all the files and folder structure necessary for the mod to work as normal, in my case it look like this:
Now it comes what makes the magic possible: the project.xml file. this is the one in charge of guide the game for using our modded files instead of the originals without touching the internal system.
Pick the template file in the download section or copy the follow inside a notepad and save it in the Mod Folder Name as project.xml:
<?xml version="1.0" encoding="utf-8"?>
<project>
<PreviewIconFile>preview_icon.png</PreviewIconFile>
<ItemDescriptionShort/>
<ModDataPath>Darkest Dungeon/mods/(Mod Folder Name)/</ModDataPath>
<Title>(Title Mod)</Title>
<Language>english</Language>
<UpdateDetails/>
<Visibility>public</Visibility>
<UploadMode>direct_upload</UploadMode>
<VersionMajor>1</VersionMajor>
<VersionMinor>0</VersionMinor>
<TargetBuild>0</TargetBuild>
<Tags>
</Tags>
<ItemDescription>
(copy description of your Mod in here, for informative purposes.)
“(Title Mod)” is not an official Red Hook Studios product or product modification, and Red Hook Studios Inc. is not responsible in any way for changes or damages that may result from using the mod.
Furthermore, “Darkest Dungeon” and the Darkest Dungeon logo are trademarks of Red Hook Studios Inc. All content in the game is Copyright Red Hook Studios Inc. All rights reserved.
</ItemDescription>
</project>
Now we fill the template according of our Mod replacing the bold text with the right data , the version section is for indicate what is the version of our mod: VersionMajor first, VersionMinor second and TargetBuild last:
<?xml version="1.0" encoding="utf-8"?>
<project>
<PreviewIconFile>preview_icon.png</PreviewIconFile>
<ItemDescriptionShort/>
<ModDataPath>Darkest Dungeon/mods/Beginner Mod Pack/</ModDataPath>
<Title>Beginner Mod Pack - Balance Mod</Title>
<Language>english</Language>
<UpdateDetails/>
<Visibility>public</Visibility>
<UploadMode>direct_upload</UploadMode>
<VersionMajor>1</VersionMajor>
<VersionMinor>2</VersionMinor>
<TargetBuild>0</TargetBuild>
<Tags>
</Tags>
<ItemDescription>
1. Start the game with 2 torches and 1 Skeleton Key so you can open the first chest (AKA Trolling chest).
2. Remove "Kleptomaniac" from the initial crusader (because screw that quirk).
3. Be able to buy firewood from the provisions store, it cost 1250 gold with a sell price of 125 gold (making it a conscious choice). Provisions available to buy before embark: Short 1, Medium 2, Long 3, Longest 4.
“Beginner Mod Pack” is not an official Red Hook Studios product or product modification,and Red Hook Studios Inc. is not responsible in any way for changes or damages that may result from using the mod.
Furthermore, “Darkest Dungeon” and the Darkest Dungeon logo are trademarks of Red Hook Studios Inc. All content in the game is Copyright Red Hook Studios Inc. All rights reserved.
</ItemDescription>
</project>
Lastly we put a preview icon inside the Mod Folder Name for show in the list mod inside the game; is simply a png file of 512 x512 pixels, i made this one for the Mod:
then we start the game and we notice a blue hammer for select the Mods: