| 1.1.0 | 2020.09.07 - 2020.09.22 | No | [](https://github.com/Impostor/Impostor/releases/tag/v1.1.0) |
| 1.2.2 | 2020.09.22 - 2020.11.17 | Yes | [](https://ci.appveyor.com/project/Impostor/Impostor/branch/dev/artifacts) |
-There are no special features at this moment, the goal is aiming to be as close as possible to the real server, for now. In a later stage, making modifications to game logic by modifying `GameData` packets can be looked at.
-
## Features
- All Among Us features are implemented. It is a full replacement for the official server.
If you just want to play on a server hosted by someone else, you need to follow these instructions.
+#### Windows
+
1. Find the [latest release](https://github.com/AeonLucid/Impostor/releases/latest).
2. Download `Impostor-Client-win-x64.zip`.
3. Extract the zip.
+If you do not wish to execute any programs. Follow the instructions in [this website](https://impostor.github.io/Impostor)
+
+#### Android
+
+##### Android 10 and below.
+1. Go to [this website](https://impostor.github.io/Impostor) **(ON YOUR MOBILE DEVICE)**
+2. Follow the instructions listed there.
+
+##### Android 11.
+1. Connect your phone to a computer. Go to [this website](https://impostor.github.io/Impostor) on the computer and follow the steps 1 and 2 to generate a `regionInfo.dat` file.
+2. Instead of following the next steps, open the phone's internal storage on your computer and navigate to `/sdcard/Android/data/com.innersloth.spacemafia/files`.
+3. Copy the generated `regionInfo.dat` file into the `files` folder you just navigated to.
+
+#### iOS
+
+iOS devices need to be jailbroken in order to connect to Impostor servers.
+
### Server
See the [docs](docs/Running-the-server.md) for instructions on how to set it up.
+## Troubleshooting
+
+See [TROUBLESHOOTING](docs/TROUBLESHOOTING.md) to solve issues the Impostor client or the server.
+
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md).
2. Find the [latest dev release](https://ci.appveyor.com/project/Impostor/Impostor/branch/dev/artifacts).
3. Download either the Windows or the Linux version.
4. Extract the zip.
-5. Modify `config.json` to your liking.
+5. Modify `config.json` to your liking. Documentation can be found [here](Server-configuration.md) *(this step is mandatory if you want to expose this server to other devices)*
6. Run `Impostor.Server.exe` (Windows) / `Impostor.Server` (Linux)
### Using docker
## Options
-### Server
+### Required Server Configuration
| Key | Default | Description |
|-|-|-|
-| **PublicIp** | `127.0.0.1` | This needs to the IPv4 address of the server, what you give to others to connect. You can find the your IPv4 address [here](http://whatismyip.host/). Since 1.2.2 it is also possible to use hostnames instead of IPv4 addresses, these must resolve to a valid IPv4 address. |
-| **PublicPort** | `22023` | The public port of the server, what you give to others to connect. Usually `22023`. |
+| **PublicIp** | `127.0.0.1` | This needs to the public IPv4 address of the server which you give to others to connect. You can find your IPv4 address [on this website](http://whatismyip.host/). Unless you are only planning to use Impostor privately, on your local network, you should change this to your public ip. It is also possible to use hostnames instead of IPv4 addresses, which will be resolved to IPv4 addresses. |
+| **PublicPort** | `22023` | The public port of the server which you give to others to connect. (**This is the external port you configure on your router when port forwarding.**) Usually `22023`. |
| **ListenIp** | `0.0.0.0` | The network interface to listen on. If you do not know what to put here, use `0.0.0.0`. Since 1.2.2 it is also possible to use hostnames instead of IPv4 addresses, these must resolve to a valid IPv4 address. |
| **ListenPort** | `22023` | The listen port of the server, usually `22023`. |
| Key | Default | Value |
|-|-|-|
-| **BanIpFromGame** | `true` | When a player is caught hacking, he will be kicked from the server. If this value is set to `true`, the player will also be banned and can not rejoin that specific game. |
+| **BanIpFromGame** | `true` | When a player is caught hacking, they will be kicked from the server. If this value is set to `true`, the player will be banned instead and will not be able to rejoin that specific game. **(Setting this to false does not disable the anti-cheat!)** |
### ServerRedirector
-
+In a multi-node setup these need to be specified.
| Key | Default | Value |
|-|-|-|
| **Enabled** | `false` | Whether the server runs in multi-node setup. If this is `false`, all other options in this section do not have any effect. |
IMPOSTOR_ServerRedirector__Nodes__0__Port=22024
IMPOSTOR_ServerRedirector__Nodes__1__Ip=127.0.0.1
IMPOSTOR_ServerRedirector__Nodes__1__Port=22025
-```
\ No newline at end of file
+```
--- /dev/null
+# Troubleshooting
+If you're reading this, something went wrong.
+Don't worry though, as this is the most thorough guide to help you!
+
+## `./Impostor.Server: line 1: ELF: not found` (plus other errors)
+No idea where you got that system. But we clearly do **NOT** support it.
+
+## `cannot execute binary file: Exec format error`
+Please check that you have downloaded the right version of Impostor, as we mantain two CPU architectures (x64 and ARM).
+Unless you are running Impostor on a SBC (Single-Board Computer), like the Raspberry Pi, you most likely want to use the x64 version.
+
+## `./Impostor.Server: Permission denied`
+This is an error related to Linux file permissions.
+Some files do not hold their executable bit (the permission that allows them to run) during a download.
+You can solve this by doing: `chmod +x Impostor.Server`
+
+## `You are using an older version of the game`
+You are using an older version of Impostor. The game does not really check who is outdated and blames it on the user.
+Make sure you got the latest working version of Impostor (probably in AppVeyor, not Github).
+
+## `You disconnected from the server. Reliable Packet 1 ...`
+Please double-check that you have followed the [Server Configuration](Server-configuration.md) correctly.
+**NOTE: Your public ip does not start with `127` nor `192`**
+Also check if the port Impostor (ListenPort) is listening on is correctly port-forwarded for UDP (or TCP/UDP).
+
+## `Could not load file or assembly...`
+Please check that you only have **working** plugins in the `plugins` folder.
+This error can be caused by non-plugin files or plugins that are not working correctly.
projects / rhonda / impostor.git / commitdiff