https://github.com/bf3rm/vumm-cli
VU Mod Manager CLI
https://github.com/bf3rm/vumm-cli
venice-unleashed vumm
Last synced: about 1 month ago
JSON representation
VU Mod Manager CLI
- Host: GitHub
- URL: https://github.com/bf3rm/vumm-cli
- Owner: BF3RM
- License: mit
- Created: 2021-03-06T20:26:04.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-19T21:37:01.000Z (about 1 year ago)
- Last Synced: 2025-05-07T05:05:19.088Z (about 1 month ago)
- Topics: venice-unleashed, vumm
- Language: Go
- Homepage:
- Size: 383 KB
- Stars: 5
- Watchers: 10
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/BF3RM/vumm-cli/releases/latest/download/vumm_windows_amd64.msi) |
| Windows | 64bit | Archive | [Latest](https://github.com/BF3RM/vumm-cli/releases/latest/download/vumm_windows_amd64.zip) |
| Windows | 32bit | Installer | [Latest](https://github.com/BF3RM/vumm-cli/releases/latest/download/vumm_windows_386.msi)
| Windows | 32bit | Archive | [Latest](https://github.com/BF3RM/vumm-cli/releases/latest/download/vumm_windows_386.zip) |
| Linux | 64bit | Archive | [Latest](https://github.com/BF3RM/vumm-cli/releases/latest/download/vumm_linux_amd64.tar.gz) |
| Linux | 32bit | Archive | [Latest](https://github.com/BF3RM/vumm-cli/releases/latest/download/vumm_linux_386.tar.gz) |
| Darwin | 64bit | Archive | [Latest](https://github.com/BF3RM/vumm-cli/releases/latest/download/vumm_darwin_amd64.tar.gz) |
You can find other releases [here](https://github.com/BF3RM/vumm-cli/releases).
## 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:
```bash
vumm install
```
So the following command will install the latest version of [BlueprintManager](https://github.com/BF3RM/BlueprintManager):
```bash
vumm install blueprintmanager
```
You can also specify a specific release tag or [semver constraint](https://docs.npmjs.com/about-semantic-versioning):
```bash
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.
```bash
vumm login [--type ]
```
Registering has the exact same syntax. If you registered successfully it's not needed to login as the access token will already be stored.
```bash
vumm register [--type ]
```
### Publish a mod
As a mod creator you can simply publish your mod by running the following command in your mod source folder
```bash
vumm publish [-t ] [--private]
```
It will read the [mod.json](https://docs.veniceunleashed.net/modding/your-first-mod/#the-modjson-file) 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.
```bash
vumm grant # give someone publish or read rights over a mod
vumm revoke # 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:
```bash
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:
```bash
vumm update
```
To see the currently installed version of VUMM you can run:
```bash
vumm --version
```
## License
The Venice Unleashed Mod Manager CLI is available under the MIT license. See the [LICENSE](./LICENSE) file for more info.