Releases: Vermintide-Mod-Framework/Vermintide-Mod-Builder
VMB v1.8.2
What's Changed
- Building mods now uses the
core/
folder found in the SDK install directory instead of thecore/
folder inside a mod's source folder.
You can revert this behavior by passing in the any of the following flags:-useModCore
,-use-mod-core
,-core
,-c
- Fixed a issue with
.stream
files not being copied from the.temp
folder into the local workshop directory when building mods locally. - Added in a github actions that allow for automatic publishing of releases
Full Commit Log: 1.8.0...1.8.2
VMB v1.8.0
This version introduces various improvements and fixes.
- vmf mod template has been updated. Since there's documentation now, all example code has been stripped out.
vmb build
andvmb upload
will now show stingray and steam uploader errors respectively. The errors will be shown even if --verbose flag isn't set.- Files and folders starting with
.
(dot) are now ignored by default when usingvmb build
,vmb upload
andvmb watch
, in addition tovmb build --source
that used to do this already. This can be disabled with--dot
or--include-dot-files
in command line or by settinginclude_dot_files
in .vmbrc. ignored_dirs_per_mod
option has been added to .vmbrc. This can be used to specify a list of folders that will be ignored when watching mods or copying source code.- Watched mods shouldn't be rebuilt more than once anymore when multiple files have been changed. In addition, watched mods are now built consecutively instead of simultaneously when files from multiple mods have been changed. This fixes overlapping console output.
vmb watch
should persist through various file system errors instead of terminating the process.vmb watch
will now log ignored files if--verbose
flag is set.
Additional minor changes:
- Updated pkg to v4.3.7.
- Absolute template dir paths are converted to forward slashes just like all other paths.
VMB v1.7.0
This version has two noticeable changes:
- When creating, publishing or opening a mod, the workshop page is now opened directly in the Steam client via the
steam://
protocol. The displayed url is unchanged by this. - The program now looks for the config file and the template in the current and
%userprofile%
directories before defaulting to the directory with the executable.
The full priority lists are as follows:- .vmbrc: --rc -> -f -> cwd -> %userprofile% -> executable directory
- template: -f -> cwd -> mods_dir -> %userprofile% -> executable directory
VMB v1.6.3: Fix for Vermintide 1 steam uploader
The -x
parameter (used to skip manually agreeing to the EULA) is no longer passed to the Vermintide 1 steam workshop uploader as it doesn't support or require that parameter.
VMB v1.6.2: Agreeing to EULA now works in shells other than cmd
This update makes use of the new uploader parameter that makes it possible to agree to EULA in various non-standard command line shells.
This also removes the need for robotjs, so robotjs.node isn't included in the archive anymore and can be deleted from your folder with vmb.
Other changes:
- Removed unnecessary brackets from mod options config example in .template-vmf
VMB v1.6.1: Copy source code without --source flag and new default mod preview image
This update adds the ability to copy source code of a mod without the --source flag by setting copy_source_code
in .vmbrc to true
. --copy-source-code
is now an alternative to the --source
flag for the sake of consistency.
Note that you can temporarily reset flags by setting them to 0 (--source=0
means source code won't be copied even if copy_source_code
is set to true
).
Also, this update replaces the old .jpg template item preview image with a new better .png one by sL1bu. You'll need to change the preview file extension in .vmbrc to .png by hand or by running the following command:
vmb config --template_preview_image="item_preview.png"
VMB v1.6.0: --help and --version parameters
This update adds --help
and --version
parameters.
vmb <command> --help
or vmb help <command>
will open the wiki page of that command.
vmb --help
or just vmb
will print all existing commands and parameters to the console as before.
vmb help
will open the home page of the wiki.
--version
will print the version number.
I've also moved and expanded most of the usage info from the README file to the wiki.
Other changes:
- Fix: use node instead of cmd rmdir to remove temp folder.
- Allow setting --ignore-errors to false via cl params if it was set to true in .vmbrc with --ignore-errors=0.
VMB v1.5.0: Source copying
This update adds source deletion/copying.
When building, watching or publishing mods, you can specify --source
flag. This will copy all files (except .cfg and item preview files, and except bundle folders) to the source
folder in the current bundle folder.
At the start of execution of these tasks all source folders are deleted to prevent stingray.exe from building extraneous bundles from them.
Copying source code is required in order for mods to be sanctionable. To apply for sanctioning, follow these steps:
- Set
apply_for_sanctioned_status
totrue
in mod's itemV2.cfg file. vmb build mod --source
vmb upload mod
Other changes:
- You no longer need to specify extension when using
--cfg
param, now it's always .cfg.
Before 1.5.0:vmb build mod --cfg=beta.cfg
Since 1.5.0:vmb buld mod --cfg=beta
- You can specify 'content' field of .cfg files when creating or publishing mods with
--content
(or simply-c
) param. This determines where built mod files and source code are going to end up and where they will be uploaded from.
Since 1.5.0:vmb publish mod --cfg=beta --content=bundleBeta
--show-cfg
flag is now used to display .cfg file contents when usingvmb info
instead of--cfg
flag, which conflated with overall--cfg
param.
Before 1.5.0:vmb info mod --cfg
Since 1.5.0:vmb info mod --show-cfg
- Newly created .cfg files are now deleted if something went wrong during publishing.
- Updated to Node 10.
VMB v1.4.0: Auto agree to EULA
This version removes the need to press Y every time you upload a mod to agree to Vermintide EULA.
This is done by simulating a key press using robotjs. robotjs.node (included in the archive) needs to be placed alongside the executable for this to work. If it is missing, you'll need to keep pressing the button yourself.
VMB v1.3.1: New building process
This update is required for mods to be sanctioned when that starts happening.
You need to switch Vermintide 2 SDK app to upcoming_patch branch in Tools -> Warhammer: Vermintide 2 SDK (Alpha) -> Right click -> Properties -> Betas.
Then simply do
vmb build -g=2
vmb upload --all -g=2 -n="New loading process"
to rebuild and upload all your V2 mods.
Changelog:
- Building process has been altered for Vermintide 2 mods to work with new loading process:
- .mod_bundle file now retains the name given to it by the stingray compiler
- .mod file is now included with the .mod_bundle file
- Rebuilt mods will work both on public and mod-test branches of the game.
- You can switch to old build format by setting use_new_format2 in .vmbrc to false.
- Improve typechecking in vmb config.
- Minor change to template-vmf: if vmf hasn't been loaded, mod title will be displayed instead of mod name in the error message.