aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRémy Raes <contact@remyraes.com>2022-01-01 22:30:01 +0100
committerGitHub <noreply@github.com>2022-01-01 22:30:01 +0100
commit1598d8b3510580cd886c884b80a69c7b2bcfa422 (patch)
tree1452eacea43b6e6c6a52d75b8159f4af6588819f /docs
parentb91a1ad65ec617486bc6c99d6334cea249db7e15 (diff)
downloadViper-1598d8b3510580cd886c884b80a69c7b2bcfa422.tar.gz
Viper-1598d8b3510580cd886c884b80a69c7b2bcfa422.zip
chore: Auto updating (#16)
* [chore] adding electron-updater dependency * [feat] adding auto-updating mechanism * [chore] setting package version to v0.8.0 * [fix] restoring original repo URL * [docs] adding some documentation about publishing new releases * [chore] adding publish:windows command * [docs] updating publish instructions with new publish command * [chore] adding publish:linux command * [docs] updating publish instructions * --updatevp, and option to disable auto updates If you want you can set "autoupdates" to false in your config, no GUI tools to do this yet. For the CLI auto updates is off by default and you'll have to use --updatevp. I also removed the snap package, tho whether this stays as a change is still to be discussed. And with the new option I updated the help menu, the man page and everything along else that needs it. * removed "soon" parts of README for auto-updates * [feat] adding French translation for cli.help.updatevp key * confirmation for restarting the app Now instead of automatically updating and restarting the app, which may be slightly confusing to some users, (the app opens then closes and then opens), it now asks whether you want to restart and open the new version. If you say no, instead next time you launch it, it'll be on the new version. If you want to completely disable updates you can disable it in the viper.json file... * [feat] adding French translation for gui.update.available key * added configuration instruction in README Co-authored-by: 0neGal <mail@0negal.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/viper.17
-rw-r--r--docs/viper.1.md5
2 files changed, 9 insertions, 3 deletions
diff --git a/docs/viper.1 b/docs/viper.1
index 0b399b8..5b5b913 100644
--- a/docs/viper.1
+++ b/docs/viper.1
@@ -1,4 +1,4 @@
-.TH "VIPER" "1" "December 2021" "" ""
+.TH "VIPER" "1" "January 2022" "" ""
.SH "NAME"
\fBviper\fR \- update and manage northstar
.SH SYNOPSIS
@@ -6,7 +6,7 @@
\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 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
@@ -22,6 +22,9 @@ Viper is a program made to make updating and launching Northstar a lot easier\.
\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
diff --git a/docs/viper.1.md b/docs/viper.1.md
index fa531c3..e271f4f 100644
--- a/docs/viper.1.md
+++ b/docs/viper.1.md
@@ -7,7 +7,7 @@ viper(1) -- update and manage northstar
## 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 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
@@ -24,6 +24,9 @@ Viper is a program made to make updating and launching Northstar a lot easier. I
`--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`