diff options
| author | 0neGal <mail@0negal.com> | 2022-01-08 15:05:35 +0100 |
|---|---|---|
| committer | 0neGal <mail@0negal.com> | 2022-01-08 15:13:07 +0100 |
| commit | 1c12fb2e90d26e25be6206076ad6762fa92a5962 (patch) | |
| tree | 89e0035a458948f58ccc9b4aa4cac7fccb523cd5 /docs/viper.1.md | |
| parent | 927def020baf544a23140ba8cfa53dcef9f23aa8 (diff) | |
| download | Viper-1c12fb2e90d26e25be6206076ad6762fa92a5962.tar.gz Viper-1c12fb2e90d26e25be6206076ad6762fa92a5962.zip | |
added cli arguments for mods
This adds both the arguments themselves, but also their entries in the
man page and help page.
Diffstat (limited to 'docs/viper.1.md')
| -rw-r--r-- | docs/viper.1.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/viper.1.md b/docs/viper.1.md index e271f4f..daa9263 100644 --- a/docs/viper.1.md +++ b/docs/viper.1.md @@ -34,6 +34,18 @@ Viper is a program made to make updating and launching Northstar a lot easier. I `--setpath`=<absolute-path> Sets the game path, this'll change the `gamepath` variable in your `viper.json`, note that it only takes in absolute paths and not relative ones. +`--mods` + Lists out all installed mods, and gives a count on how many are installed, enabled and or disabled. + +`--installmod`=<absolute-path> + Installs a mod, this supports both Zip files and folders, just that the `mod.json` file is easily found is all that matters. + +`--removemod`=<mod name> + Removes a mod, the mod name should be taken from `--mods` as it provides accurate names. Putting in `allmods` will remove all mods, no confirmation. + +`--togglemod`=<mod name> + Toggles a mod, the mod name should be taken from `--mods` as it provides accurate names. Putting in `allmods` will toggle all mods. Keep in mind, if a mod is already disabled and some mods are enabled, the states will be flipped, so 3 enabled and 1 disabled, goes to 1 enabled and 3 disabled. + ## CONFIGURATION All configuration takes place in your `viper.json` file, this file may be in various locations depending on your platform, for Linux you're likely to find it at: @@ -45,6 +57,10 @@ On Windows it's likely to be in `%APPDATA%\viper.json` All configuration is done by Viper itself, the locale is auto set when the GUI launches through your systems locale, the gamepath is selected with `--setpath` or in the GUI. +## MOD SUPPORT + +To toggle mods since Northstar itself has no filter as to what mods it loads, we have to move the mods into a separate folder, that folder being `disabled` inside `R2Northstar/mods`, so you can also just manually move these if you want. + ## BUGS Report bugs on the GitHub issues page, and feel free to make a pull request if you also have the fix to the bug. |