From: AeonLucid Date: Mon, 21 Sep 2020 18:08:48 +0000 (+0200) Subject: Update README X-Git-Tag: v1.1.0~6 X-Git-Url: https://git.deb.at/?a=commitdiff_plain;h=a1b5ba2819acaa0c4794704502af6fb03afc4436;p=rhonda%2Fimpostor.git Update README --- diff --git a/README.md b/README.md index e330f26..83e9540 100644 --- a/README.md +++ b/README.md @@ -25,13 +25,19 @@ Almost all standard features are implemented at this moment, except for public g ## Installation +If you just want to play, follow the client instructions. + When hosting a server, make sure port **22023** is open and forwarded for **UDP**. It is not possible to use a different port because Among Us seems to have hardcoded 22023, even though the functionality for setting a port exists. ### Client If you just want to play on a server hosted by someone else, you need to follow these instructions. -> W.I.P +1. Find the [latest release](https://github.com/AeonLucid/Impostor/releases/latest). +2. Download `Impostor-Client-win-x64.zip`. +3. Extract the zip. +4. Run `Impostor.Client.exe`. +5. Follow the instructions inside the application. ### Server (Docker) @@ -44,7 +50,7 @@ docker run -p 22023:22023/udp aeonlucid/impostor ### Server (Windows / Linux) -1. Find the [latest release](https://github.com/AeonLucid/Impostor/releases/latest) +1. Find the [latest release](https://github.com/AeonLucid/Impostor/releases/latest). 2. Download either the Windows or the Linux version. 3. Extract the zip. 4. Run `Impostor.Server.exe` (Windows) / `Impostor.Server` (Linux)