An open-source, community-run framework that provides enhanced Darktide modding support.
assets | ||
dmf | ||
.dmbrc | ||
.gitignore | ||
.luacheckrc | ||
.travis.yml | ||
CONTRIBUTORS.MD | ||
LICENSE | ||
README.MD |
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:
- To start, you should be subscribed to the VMF Beta in Steam Workshop. (Warhammer End Times - Vermintide or Warhammer: Vermintide 2, depending on which version you want to compile)
- You should also install Vermintide Mod Builder (VMB).
Building Steps:
- Navigate to your VMB directory. Let's assume it's unpacked into a folder named
vermintide-mod-builder
. - Create a folder inside
vermintide-mod-builder
(we'll call itvermintide-mod-framework
) and clone in the VMF repository's contents. - 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.
Steam Workshop Links
Beta builds:
Stable builds: