alterware-launcher/README.md

94 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2023-09-03 13:03:46 -04:00
# AlterWare Launcher
2023-06-01 06:23:23 -04:00
2023-09-03 13:03:46 -04:00
### [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
2023-06-12 12:34:47 -04:00
3. Run alterware-launcher.exe, after updating the game will launch automatically
---
2023-09-03 13:03:46 -04:00
#### Command line arguments
- ```iw4-sp```, ```iw4x```, ```iw5-mod```, ```iw6-mod```, ```s1-mod```
- Skip automatic detection and launch the specified game
2023-09-14 19:45:47 -04:00
- This should always be the first argument if used
- ```--update```, ```-u```
- Only update the game, don't launch it
- ```--skip-launcher-update```
- Don't update the launcher
- ```--bonus```
- Download bonus content
- ```--force```, ```-f```
- Force file hash recheck
2023-09-14 03:44:35 -04:00
- ```--path```, ```-p```
- Set the game path
2023-09-14 04:08:26 -04:00
- Do not include a trailing backslash in the path
2023-09-14 04:25:44 -04:00
- ```--pass```
- Pass additional arguments to the game
- See [client-args.md](client-args.md)
2023-09-14 19:45:47 -04:00
- ```--version```, ```-v```
- Print the launcher version
Example: ```alterware-launcher.exe iw4x --bonus -u --path "C:\Games\IW4x" --pass "-console"```
2023-09-10 12:29:30 -04:00
Some arguments can be set in alterware-launcher.json, args generally override the values of the config.
2023-09-03 13:03:46 -04:00
---
#### 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: ""
---
2023-09-03 13:03:46 -04:00
#### 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:
2023-09-03 13:03:46 -04:00
When the launcher updates itself it needs to be restarted. It will return exit code 201 in this case.
```
@echo off
:loop
2023-09-14 19:48:04 -04:00
start /wait alterware-launcher.exe --update
2023-09-03 13:03:46 -04:00
if %errorlevel% equ 201 (
goto loop
)
```