Add help text to script.

Signed-off-by: Philipp <>
Philipp 2 years ago
parent dff0dbccd9
commit 21cd505119
No known key found for this signature in database
GPG Key ID: 2258EE3B85DE1748
  1. 4
  2. 7
  3. 12

@ -9,7 +9,7 @@ changes.
The volatile nature of the `WINEPREFIX` leads to challenges in regards
to preservation of needed state, this is handled in the following ways:
* The Application in itself and the Launcher folder containing the
* The Application in itself and the launcher folder containing the
session data are created in the users home directory and symlinked
into each prefix.
* Internal wine settings are handled as registry files and automatically
@ -57,7 +57,7 @@ into the `Program Files` folder of the prefixs.
`starcitizen --wine winecfg`
# Disclaimer
This repository does not host any copyrighted content. All contend is fetched
This repository does not host any copyrighted content. All content is fetched
from official sources and is never redistributed by the author of this
software. It does not help in any way to cheat or pirate the game. A normal
account is still needed to install or play the game.

@ -41,6 +41,11 @@ let
name = "captureMouse.reg";
text = ./captureMouse.reg;
helpText = pkgs.writeTextFile {
name = "scHelptext";
text = ./helpText.txt;
script = pkgs.writeShellScriptBin binName ''
#sane bash
set -eo pipefail
@ -119,7 +124,7 @@ let
function help () {
echo "Gid gud!"
cat ${helpText.text}
function wine () {

@ -0,0 +1,12 @@
Usage: `starcitizen [parameters]`
`--install-prefix`: Installs the prefix if needed.
`--install-launcher`: Installs the launcher. Can be used to reinstall.
`--clean`: Deletes all but the currently used prefixes of the game.
`--remove-prefix`: Deletes the currently used prefix. Use with care.
`--run-game`: Runs the game (after installing the prefix if needed). Default behaviour.
`--print-prefix`: Prints the current prefix path.
`--help`: Prints help text.
`--wine`: Runs a wine executable inside the context of the script. Example:
`starcitizen --wine winecfg`