An open-source, community-run framework that provides enhanced Darktide modding support.
Find a file
2023-01-09 15:18:41 -07:00
assets Host vmf logo in repository (#12) 2018-06-07 10:40:51 -06:00
dmf Delaying hooks in perpetuity, report delayed hooks on unload, re-run delayed hooks if a class name matches 2023-01-09 15:18:41 -07:00
.dmbrc Rename directories 2023-01-06 03:10:16 -07:00
.gitignore Add new line at end of all files 2019-01-01 06:08:51 +03:00
.luacheckrc Reset for Darktide 2023-01-08 04:23:26 -07:00
.travis.yml Add new line at end of all files 2019-01-01 06:08:51 +03:00
CONTRIBUTORS.MD New io library to take file loading inhouse. New io methods for the mod object 2023-01-08 18:53:05 -07:00
LICENSE Add new line at end of all files 2019-01-01 06:08:51 +03:00
README.MD Rename directories 2023-01-06 03:10:16 -07:00

Darktide Mod Framework

Welcome to the Darktide Mod Framework (DMF) Repository!

The Darktide Mod Framework is an open-source, community-run framework of modules that provides enhanced modding capabilities and support. The framework is designed to be both independent and lightweight; making no changes to gameplay on its own.

Mods created for the project may utilize:

  • Mod options
  • Shared function hooks
  • Chat commands
  • Keybinds
  • Rewritten, lightweight mod functions
  • An on-event call system

The Darktide Mod Framework originally started in Warhammer End Times: Vermintide as an unofficial modding platform. In the time since, DMF has been rewritten and redesigned with contributions from many unique members of the community; culminating in this unified project.

For more information, check out the framework's wiki pages.

Building the Framework

Prerequisites:

Building Steps:

  1. Navigate to your VMB directory. Let's assume it's unpacked into a folder named vermintide-mod-builder.
  2. Create a folder inside vermintide-mod-builder (we'll call it vermintide-mod-framework) and clone in the VMF repository's contents.
  3. Open a console/Command Prompt/PowerShell window inside your vermintide-mod-builder directory and use the following VMB command: vmb build vmf -f vermintide-mod-framework -g [1|2], where the number after -g indicates the target Vermintide game.

You can find more VMB mod-building information in the Vermintide Mod Builder documentation.

Beta builds:

Stable builds: