VU Mod Manager CLI

Automatically install the latest versions of your favourite Venice Unleashed mods without having to worry about mod dependencies.

Venice Unleashed Mod Manager is a tool server owners can use to automatically install mods and their dependencies. It also allows developers to easily distribute new versions and don't have to worry about shipping the proper dependencies.
Furthermore the tool automatically checks compatibility between your installed mods and will warn you when something is off.

Installation

Check the matrix below to download the version you need. For windows we provide a installer. For Linux and MacOS(Darwin) you will have to manually extract the archives. You also need to add VUMM to your PATH when not using the installer.

OS	Architecture	Type	Download
Windows	64bit	Installer	Latest
Windows	64bit	Archive	Latest
Windows	32bit	Installer	Latest
Windows	32bit	Archive	Latest
Linux	64bit	Archive	Latest
Linux	32bit	Archive	Latest
Darwin	64bit	Archive	Latest

You can find other releases here.

Usage

VUMM has two purposes, to simplify the distribution of mods and to simplify the installation of mods. Below you can find different type of commands that you can use.

Manage installed mods

Installing a mod is as simple as running:

vumm install <mod>

So the following command will install the latest version of BlueprintManager:

vumm install blueprintmanager

You can also specify a specific release tag or semver constraint:

vumm install blueprintmanager@^1.0.0  # install the latest minor version of 1.x
vumm install blueprintmanager@~1.0.0  # install the latest patch version of 1.0.x
vumm install blueprintmanager@dev     # install the latest dev version of blueprintmanager

Authenticating

If you are a mod creator, or trying to install a private mod you have to be authenticated. This can be done by using the login and register commands of vumm. There are two access levels, publish and readonly. Publish means the current session is allowed to manage the user and it's mods. Readonly means the current session is only allowed to read information from the registry. The readonly type of authentication is mainly what you want on your server, whereas the publish access level is what you want if you are a mod creator.

vumm login [--type <publish|readonly>]

Registering has the exact same syntax. If you registered successfully it's not needed to login as the access token will already be stored.

vumm register [--type <publish|readonly>]

Publish a mod

As a mod creator you can simply publish your mod by running the following command in your mod source folder

vumm publish [-t <tag>] [--private]

It will read the mod.json to resolve the version, and it's dependencies automatically.
By default your mod will be published to the latest tag, when specifying the -t flag you can specify another tag like dev or beta.
To use this command you have to be logged in with publish rights.

Granting access

If you decide to publish a private mod, or willing to add multiple contributors to your mod the grant and revoke commands can be used.

vumm grant <mod> <user> <publish|readonly>  # give someone publish or read rights over a mod
vumm revoke <mod> <user>                    # revoke all permissions of user over a mod

If your mod is private you can use the grant command to give people read rights over the mod like so:

vumm grant realitymod paulhobbel readonly

Updating VUMM

VUMM has an automatic updater built in which checks on a weekly basis for updates. If an update is available it will notify you about it. You can always manually check for updates by running:

vumm update

To see the currently installed version of VUMM you can run:

vumm --version

License

The Venice Unleashed Mod Manager CLI is available under the MIT license. See the LICENSE file for more info.