Skip to content

Command : Build

dalokraff edited this page Aug 12, 2023 · 6 revisions

Build all or specified mods from current directory.

vmb build [<mod_name1> <mod_name2>...] [--ignore-errors] [--verbose] 
                                       [--clean] [--id <item_id>]
                                       [--no-workshop] [--source]
                                       [--core]

Description

Build and copy the bundle to the bundle folder (specified in the .cfg file, defaults to bundleV1 or bundleV2 depending on the game), as well as replace the old bundle in Steam Workshop folder with the new one. If no mod name is specified, all mods will be built.
A .cfg file (itemV1.cfg or itemV2.cfg by default, depending on the game, or specified with --cfg) needs to be in the folder with the mod's source code and have published_id line in it.

Parameters

--verbose - prints Stingray executable console output.

--ignore-errors or --ignore-build-errors or -e - ignores Stingray executable errors and tries to copy the built bundle anyway. You can also enable this parameter by default by setting ignore_build_errors in .vmbrc to true.

--clean - deletes the temp folder instead of overwriting it (builds slower, use to force building from scratch).

--id - forces workshop item ID. This way you can build a mod without having a .cfg file in its folder. Can only be passed if building one mod.

--no-workshop - this will build the mod even if .cfg file isn't present but will only copy it to the bundle folder but not the workshop folder.

--copy-source-code or --source - this will copy the source code of the mod into <bundle_folder>/source. This includes all files inside the mod folder, except .cfg and item preview files, and excluding bundle folders. Before building, all previously copied source code folders of a mod will be deleted to prevent Stingray from creating extraneous bundles.

--core, --c, --useModCore, or --use-mod-core - the mod will build using the core/ folder inside the mod's source files instead of using the core/ folder inside the SDK install folder. If no core/ folder is found, building will fail.

Clone this wiki locally