06b23556a3
Changes includes: - No longer relies on any globals. - No longer uses loadstrings, or recreate the hook chain frivolously. - Adding :before() and :after() which will call the func before and after the function call. - Added :rawhook() that imitate the old 'back' functionality, by replacing the original function at the "end" of the chain. - Refactoring to only fetch original function once. - Refactor to use a single internal _registry table. - registry.hooks[hook_type] are now using metatable to automatically generate tables. - Rawhooks now have their own specialized hooks, that will call the original if disabled. - Make sure rawhooks are limited to one per function. - No longer has the ability to overwrite hooks. We remove a table lookup from every hook call and make the code more straightforward. - The functionality of overwriting a hook is not used in any mods. Any code that would require this can simply be written in a better way without bogging down the whole system for everyone. |
||
|---|---|---|
| assets | ||
| vmf | ||
| .gitignore | ||
| .luacheckrc | ||
| .travis.yml | ||
| CONTRIBUTING.MD | ||
| LICENSE | ||
| README.MD | ||
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:
- To start, you should be subscribed to the Steam Workshop version of VMF that you'd like to compile. (Warhammer End Times - Vermintide or Warhammer: Vermintide 2)
- 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-builderdirectory and use the following VMB command:vmb build vmf -f vermintide-mod-framework --ignore-errors -g [1|2], where the number after-gindicates the target Vermintide game.
You can find more VMB mod-building information in the Vermintide Mod Builder documentation.