Merge pull request #19 from 0neGal/mod-support

Adds mod support, removing, installing and toggling mods, both CLI and GUI

2 files changed, 31 insertions, 0 deletions

diff --git a/docs/viper.1 b/docs/viper.1
index 5b5b913..52ec4c5 100644
--- a/docs/viper.1
+++ b/docs/viper.1
@@ -31,6 +31,18 @@ Viper is a program made to make updating and launching Northstar a lot easier\.
 .P
 \fB\-\-setpath\fP=<absolute\-path>
    Sets the game path, this'll change the \fBgamepath\fP variable in your \fBviper\.json\fP, note that it only takes in absolute paths and not relative ones\.
+.P
+\fB\-\-mods\fP
+   Lists out all installed mods, and gives a count on how many are installed, enabled and or disabled\.
+.P
+\fB\-\-installmod\fP=<absolute\-path>
+   Installs a mod, this supports both Zip files and folders, just that the \fBmod\.json\fP file is easily found is all that matters\.
+.P
+\fB\-\-removemod\fP=<mod name>
+   Removes a mod, the mod name should be taken from \fB\-\-mods\fP as it provides accurate names\. Putting in \fBallmods\fP will remove all mods, no confirmation\.
+.P
+\fB\-\-togglemod\fP=<mod name>
+   Toggles a mod, the mod name should be taken from \fB\-\-mods\fP as it provides accurate names\. Putting in \fBallmods\fP 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\.
 .SH CONFIGURATION
 .P
 All configuration takes place in your \fBviper\.json\fP file, this file may be in various locations depending on your platform, for Linux you're likely to find it at:
@@ -45,6 +57,9 @@ All configuration takes place in your \fBviper\.json\fP file, this file may be i
 On Windows it's likely to be in \fB%APPDATA%\\viper\.json\fP
 .P
 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 \fB\-\-setpath\fP or in the GUI\.
+.SH MOD SUPPORT
+.P
+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 \fBdisabled\fP inside \fBR2Northstar/mods\fP, so you can also just manually move these if you want\.
 .SH BUGS
 .P
 Report bugs on the GitHub issues page, and feel free to make a pull request if you also have the fix to the bug\.
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.