Hey Modders!

Just wanted to do a short announcement to let everyone know that we are launching Workshop tomorrow!

If you want to make sure your mods have their preview images ready or have been waiting to publish your mod, now is the time!

To celebrate the release I will be streaming on Friday to showcase some of the mods that are up on the library! We've also reached out to some streamers to get a schedule of them hosted on our channel as they check out some of the mods.

We are excited and hope you all are as well!

Cheers!

Greetings modders!

Today we are soft launching the workshop support.
We’ll give an overview of the steps we’re taking and if you have any questions, please don't hesitate to let us know!

First, you no longer need to be working off of the special workshop beta branch in Steam. All of the workshop features are currently live in the main build of the game, but you will only see those features when you are subscribed to a mod from Steam Workshop.

For the moment, the only way to to subscribe to a mod from the Steam Workshop is by being a member of Darkest Dungeon - Workshop. We’ll be circulating this group a bit more and making it public, allowing anyone to join.

Once the soft-launch is concluded, we’ll do away with this requirement and any Darkest Dungeon owners will be able to subscribe to mods without needing to join the group. We hope to transition from “soft launch” to official launch within a week or two, once we are satisfied with stability.

Once we do officially launch, we plan to celebrate the hard work you all have been putting in and will showcase some of the mods on social media and our community streams. It should be a great chance to get the word out and provide some exposure for your creations!

Red Hook Studios cannot be responsible for any damage to save games caused by subscribing to mods. As mod creators, we of course encourage you to test your mod thoroughly before making it available to the public.

We will be making a sticky posted on the Modding Forums on the Steam Discussion page to start pointing people to Darkest Dungeon - Workshop, and of course, please feel free to tell your players/friends that they will need to join this group to start using the mods. We also intend for the current live build to remain unaltered for for a bit to help ensure a stable launch window for Workshop support. That said, if we find we an updated is absolutely required, we’ll try and give you guys a heads up!

-Red Hook Studios

Hey everyone!

So Kevin from Power Up Audio has helped us get the audio ready to be moddable.

First you will need to download this .zip. [darkestdungeon.com]

The directions are inside that for what software you will need to use. Then once you open the project in FMOD there are instructions and steps for how to add new sound effects to the game.

Note, these are additive, so if you are making new classes/monsters you can now create custom fmod events/sfx for them.

Happy Modding!

Hey everyone!

We just moved over the Radiant build to the workshop branch so you can continue working without having to switch branches.

We haven't had time to action any of the items on the Known Issues list. So please keep adding to them and once we get through this update we will have more info on when the Workshop rollout will happen.

Cheers!


PS: If you're running the non-steam version of the game, please use the -ugc_enabled command line parameter to enable the mods UI.

First off, thank you to everyone for taking part in this beta workshop build. It's really awesome that we have all of you to help us iron things out. Sorry for the delay between builds, holidays got in the way but hopefully the fixes and new features make up for it!

With the announcement of Radiant mode, we will be focusing on that for the coming weeks. We aren't dropping Workshop tasks, but our ability to address the next set of requests might take some time. We will still be monitoring the boards and checking for bugs and prioritizing your requests, but our goal is to get Radiant Mode and the features it brings out the door quickly.

We plan the live Workshop deployment to occur right after Radiant Mode. Radiant Mode and the mod prepping also are causing a few files to shift around for the better (e.g. we are splitting effects.darkest into multiple files that can be additive), so some of your mods might require a few tweaks once we get that sorted out as well.

The localization file format has changed (.loc). It's vital that you re-process and re-upload your mods if they contain localization changes. (Please read section below on new localization changes!)

Also, for those who have already experimented with the upload process already, you'll find out that the project files have changed from json to xml to allow more flexibility in item descriptions. The upload tool will still read your .json project file but will immediately save it out as an xml and delete the json file.

• ModDataPath - This is the absolute path, including the drive, to your mod's data folder. This should mimic the game's data folder. (forward slashes only please!)
  
• Title - Title of your mod. This will appear in the UI used to turn on/off mods.
  
• ItemDescriptionShort (new!, optional) - A short, under 512 characters, description seen when your mod is hovered on in the game's mod selection UI.
  
• ItemDescription (optional) - Description seen in the Steam UI. (under 8000 chars)
  
• Tags (optional) - Tags that best define what your mod includes or modifies. This will show up in Steam's UI.
  
• Visibility - Sets who will be able to see your mod in Steam. "private", "friends", or "public"
  
• UploadMode (new!) - This is how you would like the mod to handle the upload process.
  
  • direct_upload - Uploads your mod data folder directly.
    
  • copy_and_upload - If all files in your mod's data folder have been modifed, it uploads the folder directly. If some files haven't been modified, the upload tool will create a "upload" folder in your mod's data directly, copy the modified files in there, run the upload on the "upload" directory and finally delete the files within that directory.
    
  • strip_and_upload - Removes unmodified files from your mod's data directory and proceeds to upload directly.
    
  • dont_submit - Doesn't submit your mod to Steam. This is to run the process without having to be logged on to Steam or upload.
• ModVersionMajor (new!, optional) - The "3" in windows 3.1. If this or ModVersionMinor is non-zero, the version will show up beside your mod's title in the game's UI as "My Title (3.1)"
  
• ModVersionMinor (new!, optional) - The "1" in windows 3.1. If this or ModVersionMajor is non-zero, the version will show up beside your mod's title in the game's UI as "My Title (3.1)"
  
• TargetBuild (new!, optional) - This is the build number that you have tested your mod on. If set to non-zero, it will show up when hovering over your title in the game's mod UI.

Localization is now additive. This means you only have to supply strings you want to add or modify to your .xml files in the localization folder. When your mod is running and the runtime looks for a string, it will check your mod's strings and then look for it in the game's strings. To get localization to compile, you must run the steam_workshop_upload tool. Your loc will not simply show up because you have a .xml file in your localization folder as the game looks for .loc files which come from running the steam_workshop_upload tool.

Once you run the upload process, you will find a steam_workshop_upload.log file in the same directory as your project's xml file. This is a more detailed output of what the process has done.

If you would like to work without Steam or the upload process, you can do so by putting your mod inside the game's data/mods/ folder. One caveat to this is that you must have your project's xml file in your data directory named "project.xml". The steam_workshop_upload tool normally does this for you.

The script/starting_save are now being pulled from mods.

This is still a work in progress so I'm sure there's still issues but keep us posted and we'll try to address them as quickly as we can. Thanks!