diff --git a/README.md b/README.md index ae7c569..0e6c6cd 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,6 @@ Proton is currently unable to start the game's own regular launcher application ## TODO -- Add `--help` message - Don't use a custom server query API and query the server directly - Install mods automatically (only the `steamcmd` CLI utility seems to be able to do this from a command line shell context) - If possible, resolve mod dependencies diff --git a/dayz-mods.sh b/dayz-mods.sh index de612f9..4369f2f 100755 --- a/dayz-mods.sh +++ b/dayz-mods.sh @@ -33,8 +33,59 @@ declare -A DEPS=( [steam]=steam ) + +print_help() { + cat < + --server + Retrieve a server's mod list and add it to the remaining input. + Uses the daemonforge.dev DayZ server JSON API. + If --launch is set, it will automatically connect to the server. + + -p + --port + The server's query port (not to be confused with the server's game port). + Default is: 27016 + +Environment variables: + + STEAM_ROOT + Set a custom path to Steam's root directory. Default is: + \${XDG_DATA_HOME:-\${HOME}/.local/share}/Steam + which defaults to ~/.local/share/Steam + + If the game is stored in a different Steam library directory, then this + environment variable needs to be set/changed. +EOF +} + + while (( "$#" )); do case "${1}" in + -h|--help) + print_help + exit + ;; -d|--debug) DEBUG=1 ;;