From 92663425ef5ef68c28c7645fdd0f784b3ec550ad Mon Sep 17 00:00:00 2001 From: mxve <68632137+mxve@users.noreply.github.com> Date: Sun, 3 Sep 2023 19:03:46 +0200 Subject: [PATCH] update readme --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 42 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 367431a..5c9ba68 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,50 @@ -# alterware-launcher +# AlterWare Launcher -1. Download [latest release](https://github.com/mxve/alterware-launcher/releases/latest/download/alterware-launcher-x86_64-pc-windows-msvc.zip) -2. Unpack the archive and place alterware-launcher.exe in the game directory +### [AlterWare.dev](https://alterware.dev) + +##### IW4x | IW4-SP | IW5-Mod | IW6-Mod | S1-Mod + +--- + +#### Installation + +1. Download the [latest alterware-launcher.exe](https://github.com/mxve/alterware-launcher/releases/latest/download/alterware-launcher.exe) +2. Place alterware-launcher.exe in the game directory 3. Run alterware-launcher.exe, after updating the game will launch automatically --- -- Passing ```iw4-sp```, ```iw5-mod```, ```iw6-mod``` or ```s1-mod``` as the first argument will skip automatic game detection +#### Command line arguments + +- Passing ```iw4-sp```, ```iw4x```, ```iw5-mod```, ```iw6-mod``` or ```s1-mod``` as the first argument will skip automatic game detection - Passing ```update``` will stop the launcher from launching the game -- ```skip-launcher-update``` skips self-update +- ```skip-launcher-update``` skips launcher self-update + +--- + +#### Support + +Visit the [AlterWare Forum](https://forum.alterware.dev/) or [Discord](https://discord.gg/2ETE8engZM) for support. + +--- + +#### Building from Source + +- [Install Rust](https://rustup.rs/) +- Clone the repository +- Run ```cargo build --release``` +- The executable will be located in ```target/release``` + +--- ### Note for server owners: -When the launcher updates itself it needs to be restarted. It will return exit code 201 in this case. \ No newline at end of file +When the launcher updates itself it needs to be restarted. It will return exit code 201 in this case. + +``` +@echo off +:loop +start /wait alterware-launcher.exe update +if %errorlevel% equ 201 ( + goto loop +) +``` \ No newline at end of file