From 123a8b7cafa103fb8dcef120068ac55f5f7fc854 Mon Sep 17 00:00:00 2001 From: mxve <68632137+mxve@users.noreply.github.com> Date: Sat, 7 Oct 2023 13:24:26 +0200 Subject: [PATCH] add client-args.md; document config file --- README.md | 25 +++++++++++++++++++++++++ client-args.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 client-args.md diff --git a/README.md b/README.md index b3d1407..b6ab56d 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ - Do not include a trailing backslash in the path - ```--pass``` - Pass additional arguments to the game + - See [client-args.md](client-args.md) - ```--version```, ```-v``` - Print the launcher version @@ -41,6 +42,30 @@ Some arguments can be set in alterware-launcher.json, args generally override th --- +#### Config file +alterware-launcher.json + +- ```update_only``` + - See --update + - Default: false +- ```skip_self_update``` + - See --skip-launcher-update + - Default: false +- ```download_bonus_content``` + - See --bonus + - Default: false +- ```ask_bonus_content``` + - Ask the user if they want to download bonus content + - Default: true; false after asking +- ```force_update``` + - See --force + - Default: false +- ```args``` + - See --pass + - Default: "" + +--- + #### Support Visit the [AlterWare Forum](https://forum.alterware.dev/) or [Discord](https://discord.gg/2ETE8engZM) for support. diff --git a/client-args.md b/client-args.md new file mode 100644 index 0000000..44a593a --- /dev/null +++ b/client-args.md @@ -0,0 +1,32 @@ +# IW4x +[github.com/iw4x/iw4x-client#command-line-arguments](https://github.com/iw4x/iw4x-client#command-line-arguments) + +| Argument | Description | +|:------------------------|:-----------------------------------------------| +| `-tests` | Perform unit tests. | +| `-entries` | Print to the console a list of every asset as they are loaded from zonefiles. | +| `-stdout` | Redirect all logging output to the terminal iw4x is started from, or if there is none, creates a new terminal window to write log information in. | +| `-console` | Allow the game to display its own separate interactive console window. | +| `-dedicated` | Starts the game as a headless dedicated server. | +| `-bigminidumps` | Include all code sections from loaded modules in the dump. | +| `-reallybigminidumps` | Include data sections from all loaded modules in the dump. | +| `-dump` | Write info of loaded assets to the raw folder as they are being loaded. | +| `-nointro` | Skip game's cinematic intro. | +| `-version` | Print IW4x build info on startup. | +| `-nosteam` | Disable friends feature and do not update Steam about the game's current status just like an invisible mode. | +| `-unprotect-dvars` | Allow the server to modify saved/archive dvars. | +| `-zonebuilder` | Start the interactive zonebuilder tool console instead of starting the game. | +| `-disable-notifies` | Disable "Anti-CFG" checks | +| `-disable-mongoose` | Disable Mongoose HTTP server | +| `-disable-rate-limit-check` | Disable RCOn rate limit checks | +| `+` | Execute game command (ex. `+set net_port 1337`)| + + +# S1-Mod, IW6-Mod +| Argument | Description | +|:------------------------|:-----------------------------------------------| +| `-headless` | Use system console | +| `-dedicated` | Dedicated server | +| `-singleplayer` | Start singleplayer; Skip launcher | +| `-multiplayer` | Start multiplayer; Skip launcher | +| `+` | Execute game command (ex. `+set net_port 1337`)|