Merge branch 'main' of github.com:0neGal/viper into feat/ci-builds

4 files changed, 0 insertions, 169 deletions

diff --git a/docs/viper.1 b/docs/viper.1
deleted file mode 100644
index 52ec4c5..0000000
--- a/docs/viper.1
+++ /dev/null
@@ -1,76 +0,0 @@
-.TH "VIPER" "1" "January 2022" "" ""
-.SH "NAME"
-\fBviper\fR \- update and manage northstar
-.SH SYNOPSIS
-.P
-\fBviper\fP [<optional>\|\.\.\.]
-.SH DESCRIPTION
-.P
-Viper is a program made to make updating and launching Northstar a lot easier\. It has both a CLI and GUI tool, specifying no command line arguments opens the latter\. Viper also is able to update itself, that is if you've the AppImage or NSIS version\.
-.SH OPTIONS
-.P
-\fB\-\-help\fP
-   Shows a brief message of all the options and what they do\.
-.P
-\fB\-\-version\fP
-   Various versions numbers for Node, Electron, Viper and so on\.
-.P
-\fB\-\-cli\fP
-   Forces the CLI to activate, meaning the GUI will never run\. 
-   What purpose this has I frankly do not know\.
-.P
-\fB\-\-update\fP
-   Updates Northstar, this uses your \fBviper\.json\fP to determine the location, it also won't try to update if the installed version of Northstar is already the newest, if you must re\-install Northstar you can delete the \fBns_version\.txt\fP file in the game path\.
-.P
-\fB\-\-updatevp\fP
-   Updates Viper itself, by default CLI does not have auto updates, as a server owner may not want this, so use this option to update\.
-.P
-\fB\-\-launch\fP=<version>
-   Launches Northstar, this is currently only supported on Windows\.
-   If you must launch Vanilla you can run \fB\-\-launch=vanilla\fP
-.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:
-.RS 0
-.IP \(bu 2
-\fB$XDG_CONFIG_HOME/viper\.json\fP
-.IP \(bu 2
-\fB~/\.config/viper\.json\fP
-
-.RE
-.P
-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\.
-.SH AUTHORS
-.P
-Main contributors/maintainers to the project:
-.RS 0
-.IP \(bu 2
-0neGal mail@0negal\.com
-.IP \(bu 2
-Rémy Raes contact@remyraes\.com
-
-.RE
-
diff --git a/docs/viper.1.md b/docs/viper.1.md
deleted file mode 100644
index daa9263..0000000
--- a/docs/viper.1.md
+++ /dev/null
@@ -1,73 +0,0 @@
-viper(1) -- update and manage northstar
-=======================================
-
-## SYNOPSIS
-
-`viper` [<optional>...]
-
-## DESCRIPTION
-
-Viper is a program made to make updating and launching Northstar a lot easier. It has both a CLI and GUI tool, specifying no command line arguments opens the latter. Viper also is able to update itself, that is if you've the AppImage or NSIS version.
-
-## OPTIONS
-
-`--help`
-   Shows a brief message of all the options and what they do.
-
-`--version`
-   Various versions numbers for Node, Electron, Viper and so on.
-
-`--cli`
-   Forces the CLI to activate, meaning the GUI will never run. 
-   What purpose this has I frankly do not know.
-
-`--update`
-   Updates Northstar, this uses your `viper.json` to determine the location, it also won't try to update if the installed version of Northstar is already the newest, if you must re-install Northstar you can delete the `ns_version.txt` file in the game path.
-
-`--updatevp`
-   Updates Viper itself, by default CLI does not have auto updates, as a server owner may not want this, so use this option to update.
-
-`--launch`=<version>
-   Launches Northstar, this is currently only supported on Windows.
-   If you must launch Vanilla you can run `--launch=vanilla`
-
-`--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:
-
- * `$XDG_CONFIG_HOME/viper.json`
- * `~/.config/viper.json`
-
-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.
-
-## AUTHORS
-
-Main contributors/maintainers to the project:
-
- * 0neGal <mail@0negal.com>
- * Rémy Raes <contact@remyraes.com>
diff --git a/package-lock.json b/package-lock.json
index b5c05e4..daf74e7 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -15,7 +15,6 @@
 				"fuse.js": "^6.5.3",
 				"jsonrepair": "^2.2.1",
 				"marked": "^4.0.10",
-				"marked-man": "^0.7.0",
 				"recursive-copy": "^2.0.13",
 				"simple-vdf": "^1.1.1",
 				"unzipper": "^0.10.11"
@@ -2032,17 +2031,6 @@
 				"node": ">= 12"
 			}
 		},
-		"node_modules/marked-man": {
-			"version": "0.7.0",
-			"resolved": "https://registry.npmjs.org/marked-man/-/marked-man-0.7.0.tgz",
-			"integrity": "sha512-zxK5E4jbuARALc+fIUAanM2njVGnrd9YvKrqoDHUg2XwNLJijo39EzMIg59LecHBHsIHNtPqepqnJp4SmL/EVg==",
-			"bin": {
-				"marked-man": "bin/marked-man"
-			},
-			"peerDependencies": {
-				"marked": "^0.7.0"
-			}
-		},
 		"node_modules/matcher": {
 			"version": "3.0.0",
 			"resolved": "https://registry.npmjs.org/matcher/-/matcher-3.0.0.tgz",
@@ -4759,12 +4747,6 @@
 			"resolved": "https://registry.npmjs.org/marked/-/marked-4.0.10.tgz",
 			"integrity": "sha512-+QvuFj0nGgO970fySghXGmuw+Fd0gD2x3+MqCWLIPf5oxdv1Ka6b2q+z9RP01P/IaKPMEramy+7cNy/Lw8c3hw=="
 		},
-		"marked-man": {
-			"version": "0.7.0",
-			"resolved": "https://registry.npmjs.org/marked-man/-/marked-man-0.7.0.tgz",
-			"integrity": "sha512-zxK5E4jbuARALc+fIUAanM2njVGnrd9YvKrqoDHUg2XwNLJijo39EzMIg59LecHBHsIHNtPqepqnJp4SmL/EVg==",
-			"requires": {}
-		},
 		"matcher": {
 			"version": "3.0.0",
 			"resolved": "https://registry.npmjs.org/matcher/-/matcher-3.0.0.tgz",
diff --git a/package.json b/package.json
index ef6dc57..690f263 100644
--- a/package.json
+++ b/package.json
@@ -29,7 +29,6 @@
 		"langs": "node build/langs.js",
 		"start": "npx electron src/index.js",
 		"debug": "npx electron src/index.js --debug",
-		"man": "npx marked-man docs/viper.1.md > docs/viper.1",
 		"build": "npx electron-builder --win nsis --win portable --linux -p never",
 		"build:windows": "npx electron-builder --win nsis --win portable -p never",
 		"build:linux": "npx electron-builder --linux -p never",
@@ -54,7 +53,6 @@
 		"fuse.js": "^6.5.3",
 		"jsonrepair": "^2.2.1",
 		"marked": "^4.0.10",
-		"marked-man": "^0.7.0",
 		"recursive-copy": "^2.0.13",
 		"simple-vdf": "^1.1.1",
 		"unzipper": "^0.10.11"