philipp/nixcitizen
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add help text to script.

Browse source 
Signed-off-by: Philipp <philipp+dev@xndr.de>
This commit is contained in:
Philipp 2021-07-22 00:10:38 +02:00
parent dff0dbccd9
commit 21cd505119
No known key found for this signature in database
GPG key ID: 2258EE3B85DE1748
3 changed files with 20 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -9,7 +9,7 @@ changes.
The volatile nature of the `WINEPREFIX` leads to challenges in regards The volatile nature of the `WINEPREFIX` leads to challenges in regards
to preservation of needed state, this is handled in the following ways: 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 session data are created in the users home directory and symlinked
into each prefix. into each prefix.
* Internal wine settings are handled as registry files and automatically * 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` `starcitizen --wine winecfg`
# Disclaimer # 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 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 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. account is still needed to install or play the game.

7
default.nix
View file

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

12
helpText.txt Normal file
View file

@ -0,0 +1,12 @@
Usage: `starcitizen [parameters]`
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`