Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 3.29 KB

README.MD

File metadata and controls

69 lines (48 loc) · 3.29 KB

Vermintide Mod Framework

Build Status

Welcome to the Vermintide Mod Framework (VMF) Repository!

The Vermintide 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
  • Mutator support (for now available only in Vermintide 1)
  • Network calls
  • QHD+ UI re-scaling
  • Rewritten, lightweight mod functions
  • An on-event call system

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

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.

Steam Workshop Links

Beta builds:

Stable builds: