-
Notifications
You must be signed in to change notification settings - Fork 5
Command : Publish
Publish an existing mod to Steam Workshop.
vmb publish <mod_name> [-d <description>] [-t <title>] [-l <language>]
[-v {private|public|friends}] [-c <content_folder>]
[--tags "<tag1>; <tag2>;..."]
[--ignore-errors] [--verbose] [--clean] [--source]
This will create a .cfg file (named itemV1
or itemV2
by default depending on the game, can be overwritten with --cfg
param) for a mod if it doesn't exist then build and publish the mod to workshop as a new item.
If .cfg file is present it shouldn't have published_id
in it.
--description <description>
or -d <description>
- workshop and in-game description of the mod.
--title <title>
or -t <title>
- readable title of the mod.
--language <language>
or -l <language>
- language of the mod.
--visibility {private|public|friends}
or -v {private|public|friends}
- visibility of the mod on the workshop.
-
private
- visible to you and admins. -
public
- visible to everyone. -
friends
- visible to you, people from your friendlist and admins.
--content <content_folder>
or -c <content_folder>
- path to the content folder. Can be relative or absolute. When not absolute, it is relative to the mod's folder.
--tags "<tag1>; <tag2>;..."
- workshop tags of your mod.
--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).
--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.
Publishing for another game:
vmb publish <mod_name> -g={1|2}
Create a private beta branch of a mod:
vmb publish <mod_name> --cfg=itemBeta --content=bundleBeta --visibility={private|friends}