Skip to content

Commit

Permalink
small readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@mxve
mxve committed Sep 6, 2024
1 parent e1484ff commit 28fa770
Show file tree
Hide file tree
Showing 3 changed files with 107 additions and 64 deletions.
Binary file added .github/images/logo.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/logotype.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
171 changes: 107 additions & 64 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,125 +1,171 @@
<div align="center">

# AlterWare Launcher

### [AlterWare.dev](https://alterware.dev)
#### Official launcher for AlterWare Call of Duty mods

##### IW4x | IW4-SP | IW5-Mod | IW6-Mod | S1-Mod

![GitHub tag (with filter)](https://img.shields.io/github/v/tag/mxve/alterware-launcher?filter=!v*-pre&style=flat-square&label=Latest%20release&labelColor=F3F8FF&color=E26EE5) ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/mxve/alterware-launcher?style=flat-square&label=Release%20date&labelColor=F3F8FF&color=E26EE5) ![GitHub all releases](https://img.shields.io/github/downloads/mxve/alterware-launcher/total?style=flat-square&label=Total%20downloads&labelColor=F3F8FF&color=E26EE5)
</div>

---

**Only legitimate copies of the games are supported. If you don't own the game, please buy it.**
> [!IMPORTANT]
> **Only legitimate copies of the games are supported. If you don't own the game, please buy it.**
## Navigation

<img src=".github/images/logo.png" align="right" width="128" height="128">

- [Installation](#-installation)
- [Support](#-support)
- [Supported Games](#-supported-games)
- [Command line arguments](#%EF%B8%8F-command-line-arguments)
- [Config file](#-config-file-alterware-launcherjson)
- [Building from Source](#-building-from-source)

---

## Installation
## 📦 Installation
[**Windows**](#-windows) | [**Debian/Ubuntu**](#-debianubuntu-amd64arm64) | [**Other Linux OS**](#-other-linux-os) | [**macOS**](#-macos)


### Windows
> [!IMPORTANT]
> ### Information for server owners:
> On Windows the launcher self-updates and restarts by spawning a new console.
> For automated processes, use `--skip-launcher-update` and manually download the latest launcher from [here](https://github.com/mxve/alterware-launcher/releases/latest/download/alterware-launcher.exe).
---

### 🪟 Windows
1. Download the game from [Steam](https://store.steampowered.com/).
2. Download the appropriate version of the AlterWare launcher:
- **Windows 64-bit**: Download the [latest alterware-launcher.exe](https://github.com/mxve/alterware-launcher/releases/latest/download/alterware-launcher.exe).
- **Windows 32-bit**: Download the [latest alterware-launcher-x86.exe](https://github.com/mxve/alterware-launcher/releases/latest/download/alterware-launcher-x86.exe).
3. Place the `alterware-launcher.exe` (or `alterware-launcher-x86.exe` for 32-bit) in the game directory.
3. Place the `alterware-launcher.exe` in the game directory.
4. Run `alterware-launcher.exe`. After updating, the game will launch automatically.

### Debian/Ubuntu (amd64/arm64)
> [!NOTE]
> Windows 7 is no longer supported. [v0.6.12](https://github.com/mxve/alterware-launcher/releases/tag/v0.6.12) is the last version that will run on Windows 7.
> To keep using it set `"skip_self_update": true` in the `alterware-launcher.json` config file.
---

### 🐧 Debian/Ubuntu (amd64/arm64)

1. You can download the game from Steam using either [SteamCMD](https://developer.valvesoftware.com/wiki/SteamCMD) or the official Steam desktop app.
2. Follow the instructions provided in this [forum post](https://forum.alterware.dev/t/linux-debian-ubuntu-amd64-arm64-install-the-alterware-launcher-using-our-apt-repository/1117) to install the alterware-launcher using our self-hosted APT repository.
3. Once installed, run the launcher from your game directory to download the client files automatically. For client updates, use the launcher from the terminal with the `--update` command-line argument as explained in this [guide](https://forum.alterware.dev/t/all-clients-useful-info-for-running-our-mods-under-linux/343).
3. Once installed, run the launcher from your game directory to download the client files automatically. For updates, use the launcher from the terminal with the `--update` command-line argument as explained in [this guide](https://forum.alterware.dev/t/all-clients-useful-info-for-running-our-mods-under-linux/343).

**NOTE**: The steps above can be used for any Debian-based distribution that uses the APT package manager.
> [!NOTE]
> The steps above can be used for any Debian-based distribution that uses the APT package manager.
### Other Linux OS
---

### 🐧 Other Linux OS

1. Consult the Steam documentation to learn how to download the game from their servers.
2. Visit the [latest release](https://github.com/mxve/alterware-launcher/releases/latest) page for the AlterWare launcher and choose the release that matches your system requirements.
3. Once installed, run the launcher from your game directory to download the client files automatically. For client updates, use the launcher from the terminal with the `--update` command-line argument as explained in this [guide](https://forum.alterware.dev/t/all-clients-useful-info-for-running-our-mods-under-linux/343).
3. Once installed, run the launcher from your game directory to download the client files automatically. For updates, use the launcher from the terminal with the `--update` command-line argument as explained in [this guide](https://forum.alterware.dev/t/all-clients-useful-info-for-running-our-mods-under-linux/343).

### macOS
---

### 🍎 macOS

1. You can download the game from Steam using either [SteamCMD](https://developer.valvesoftware.com/wiki/SteamCMD) or the official Steam desktop app.
2. Download the [latest alterware-launcher](https://github.com/mxve/alterware-launcher/releases/latest/download/alterware-launcher-universal-apple-darwin.tar.gz).
3. Once installed, run the launcher from your game directory to download the client files automatically. For client updates, use the launcher from the terminal with the `--update` command-line argument as explained in this [guide](https://forum.alterware.dev/t/all-clients-useful-info-for-running-our-mods-under-linux/343).
3. Once installed, run the launcher from your game directory to download the client files automatically. For updates, use the launcher from the terminal with the `--update` command-line argument as explained in [this guide](https://forum.alterware.dev/t/all-clients-useful-info-for-running-our-mods-under-linux/343).

> [!WARNING]
> Running the AlterWare launcher on macOS has not been officially tested. However, since WINE has a macOS port, it should theoretically be possible to run our clients on this platform.
---

## ❓ Support

Need help or have questions? We're here to help you!

**DISCLAIMER**: Running the AlterWare launcher on macOS has not been officially tested. However, since WINE has a macOS port, it should theoretically be possible to run our clients on this platform.
- **AlterWare Forum**: Visit our [official forum](https://forum.alterware.dev/) for in-depth discussions, troubleshooting, and community support.
- **Discord Community**: Join our [Discord server](https://discord.gg/2ETE8engZM) for real-time chat, quick questions, and to connect with other users.

---

#### Command line arguments
## 🎮 Supported Games

> [!IMPORTANT]
> **Only legitimate copies of the games are supported. If you don't own the game, please buy it.**
> **IW4x**
> Call of Duty: Modern Warfare 2 - Multiplayer
> **IW4-SP**
> Call of Duty: Modern Warfare 2 - Singeplayer
> **IW5-Mod**
> Call of Duty: Modern Warfare 3 - Singleplayer, SpecOps
> **IW6-Mod**
> Call of Duty: Ghosts
> **S1-Mod**
> Call of Duty: Advanced Warfare
---

## ⚙️ Command line arguments

- ```iw4-sp```, ```iw4x```, ```iw5-mod```, ```iw6-mod```, ```s1-mod```
- Skip automatic detection and launch the specified game
- This should always be the first argument if used
- Must be the first argument if used
- ```--help```
- Print help
- ```--update```, ```-u```
- Only update the game, don't launch it
- Update the game without launching it
- ```--skip-launcher-update```
- Don't update the launcher
- Skip updating the launcher
- ```--bonus```
- Download bonus content
- ```--force```, ```-f```
- Force file hash recheck
- ```--path```, ```-p```
- Set the game path
- Set the game installation path
- Do not include a trailing backslash in the path
- ```--pass```
- Pass additional arguments to the game
- See [client-args.md](client-args.md)
- See [client-args.md](client-args.md) for more details
- ```--version```, ```-v```
- Print the launcher version
- ```--ignore-required-files```
- Install client even if required files are missing
- ```--skip-redist```
- Skip redistributable installation
- Skip installing redistributables
- ```--redist```
- (Re-)install redistributables
- Install or reinstall redistributables

Example: ```alterware-launcher.exe iw4x --bonus -u --path "C:\Games\IW4x" --pass "-console"```

Some arguments can be set in alterware-launcher.json, args generally override the values of the config.
##### Example:
```shell
alterware-launcher.exe iw4x --bonus -u --path "C:\Games\IW4x" --pass "-console"
```
> [!TIP]
> Some arguments can be set in alterware-launcher.json, args generally override the values of the config.
---

#### 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: ""
- ```use_https```
- Use HTTPS for downloads
- Default: true
- ```skip_redist```
- Skip redistributable installation
- Default: false

---
## 🔧 Config file `alterware-launcher.json`

#### Support

Visit the [AlterWare Forum](https://forum.alterware.dev/) or [Discord](https://discord.gg/2ETE8engZM) for support.
- `update_only`: Set to true to only update the game. Default: `false`.
- `skip_self_update`: Skip launcher updates. Default: `false`.
- `download_bonus_content`: Automatically download bonus content. Default: `false`.
- `ask_download_bonus_content`: Ask before downloading bonus content. Default: `false`.
- `force_update`: Force file recheck. Default: `false`.
- `args`: Pass additional arguments to the game. Default: `""`.
- `use_https`: Use HTTPS for downloads. Default: `true`.
- `skip_redist`: Skip redistributable installations. Default: `false`.

---

#### Building from Source
## 🔨 Building from Source

- [Install Rust](https://rustup.rs/)
- [Linux/unix] Make sure perl is installed<sup>1</sup>
Expand All @@ -129,11 +175,8 @@ Visit the [AlterWare Forum](https://forum.alterware.dev/) or [Discord](https://d

---

### Note for server owners:
When the launcher updates itself __on Windows__ it will restart by spawning a new console. If you are automating this process, you should probably use ```--skip-launcher-update``` and download the latest launcher yourself from [here](https://github.com/mxve/alterware-launcher/releases/latest/download/alterware-launcher.exe).

The linux build does __not__ update itself.

---

<sup>1</sup> [Required for OpenSSL](https://docs.rs/openssl/latest/openssl/#vendored)

<p align="center">
<img src=".github/images/logotype.png" width="512">
</p>

0 comments on commit 28fa770

Please sign in to comment.