aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
author0neGal <mail@0negal.com>2021-12-30 20:35:08 +0100
committer0neGal <mail@0negal.com>2021-12-30 20:35:08 +0100
commit823d34f6f41c65c7b1cb8e55bd429b9efc4f3878 (patch)
tree149a7274cc024c62a6625704cde0d095db53e6a3 /docs
parent9d8ceea77b6f172f0c055c0061bc07e6f45c0d2d (diff)
downloadViper-823d34f6f41c65c7b1cb8e55bd429b9efc4f3878.tar.gz
Viper-823d34f6f41c65c7b1cb8e55bd429b9efc4f3878.zip
added a lovely man page
Simply build it with "npm run man"
Diffstat (limited to 'docs')
-rw-r--r--docs/viper.158
-rw-r--r--docs/viper.1.md54
2 files changed, 112 insertions, 0 deletions
diff --git a/docs/viper.1 b/docs/viper.1
new file mode 100644
index 0000000..0b399b8
--- /dev/null
+++ b/docs/viper.1
@@ -0,0 +1,58 @@
+.TH "VIPER" "1" "December 2021" "" ""
+.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\.
+.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\-\-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\.
+.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 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
new file mode 100644
index 0000000..fa531c3
--- /dev/null
+++ b/docs/viper.1.md
@@ -0,0 +1,54 @@
+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.
+
+## 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.
+
+`--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.
+
+## 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.
+
+## 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>