Improving Documentation (#175)

* Update README.md

Removed outdated information
Added instructions for other devices

* Updated README to add Android 11 instructions

* Formatting

* Update Running-the-server.md

* Formatting

* Formatting

* Adding a more verbose explanation on configs

* Create TROUBLESHOOTING.md

* Option for windows users to use the website instead of the client

* Small tweaks to make docs more professional

* Fixing grammatical errors(Part 1)

* Fixing grammatical errors(Part 2)

* Fixing grammatical errors (Part 3)

* Update README.md

* Update README.md

* Fixing formatting

* Update README.md

Co-authored-by: AlexejheroYTB <alexejhero@gmail.com>

* Update README.md

Co-authored-by: AlexejheroYTB <alexejhero@gmail.com>

* Update README.md

Co-authored-by: AlexejheroYTB <alexejhero@gmail.com>

* Update docs/Running-the-server.md

Co-authored-by: AlexejheroYTB <alexejhero@gmail.com>

* Update docs/Server-configuration.md

Co-authored-by: AlexejheroYTB <alexejhero@gmail.com>

* Update docs/Server-configuration.md

Co-authored-by: AlexejheroYTB <alexejhero@gmail.com>

* Update docs/Server-configuration.md

Co-authored-by: AlexejheroYTB <alexejhero@gmail.com>

* Update docs/TROUBLESHOOTING.md

Co-authored-by: AlexejheroYTB <alexejhero@gmail.com>

* Update docs/TROUBLESHOOTING.md

Co-authored-by: AlexejheroYTB <alexejhero@gmail.com>

* Update docs/TROUBLESHOOTING.md

Co-authored-by: AlexejheroYTB <alexejhero@gmail.com>

* Update docs/TROUBLESHOOTING.md

Co-authored-by: AlexejheroYTB <alexejhero@gmail.com>

* Update README.md

Co-authored-by: AlexejheroYTB <alexejhero@gmail.com>

* Update README.md

* Update Server-configuration.md

* Update TROUBLESHOOTING.md

* Update TROUBLESHOOTING.md

* Update Server-configuration.md

* Update TROUBLESHOOTING.md

* Update TROUBLESHOOTING.md

* Update Server-configuration.md

Co-authored-by: AlexejheroYTB <alexejhero@gmail.com>
Co-authored-by: AeonLucid <aeonlucid@outlook.com>
This commit is contained in:
authored and GitHub committed 2020-11-30 20:04:23 +01:00
1 parent d847b5c708
commit a653fe57fd
4 files changed
+58 -9

No files matched your search

+23 -2
View File
@@ -12,8 +12,6 @@ We support Steam, Itch, Android and iOS. The latest version supported is `2020.9
| 1.1.0 | 2020.09.07 - 2020.09.22 | No | [![Download](https://img.shields.io/badge/Download-v1.1.0-blue?style=flat-square)](https://github.com/Impostor/Impostor/releases/tag/v1.1.0) |
| 1.2.2 | 2020.09.22 - 2020.11.17 | Yes | [![Download](https://img.shields.io/badge/Download-v1.2.2-blue?style=flat-square)](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.
@@ -26,6 +24,8 @@ There are no special features at this moment, the goal is aiming to be as close
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.
@@ -34,10 +34,31 @@ If you just want to play on a server hosted by someone else, you need to follow
![Client](docs/images/client.jpg)
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).