From: AeonLucid Date: Tue, 29 Sep 2020 04:17:28 +0000 (+0200) Subject: Improve README X-Git-Tag: v1.1.0~2 X-Git-Url: https://git.deb.at/?a=commitdiff_plain;h=f5fea3962d5aa9519898d9342d4d1789ec733aaa;p=rhonda%2Fimpostor.git Improve README --- diff --git a/README.md b/README.md index 9fd3378..82136c3 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,29 @@ Impostor is one of the first **Among Us** private servers, written in C#. -The latest version supported is `2020.9.9`, both desktop and mobile. +The latest version supported is `2020.9.22`, both desktop and mobile. -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` can be looked at. +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. [Discord server for Impostor](https://discord.gg/Mk3w6Tb) ## Features -Almost all standard features are implemented at this moment, except for public games. It is already possible to host and play private games. +All Among Us features are implemented. It is a full replacement for the official server. - [x] Create game - [x] Join game - [x] Start game -- [ ] Find game +- [x] Game listing - [x] V1 GameCodes (AAAA) - [x] V2 GameCodes (AAAAAA) - [x] Kick player - [x] Ban player -- [ ] Server redirection -- [ ] Server reselect +- [x] Server redirection +- [ ] Multiple master servers ## 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. @@ -41,21 +37,13 @@ If you just want to play on a server hosted by someone else, you need to follow ![Client](docs/images/client.jpg) -### Server (Docker) - -[![Docker Image](https://img.shields.io/docker/v/aeonlucid/impostor?sort=semver)](https://hub.docker.com/repository/docker/aeonlucid/impostor) -[![Docker Image](https://img.shields.io/docker/v/aeonlucid/impostor/edge)](https://hub.docker.com/repository/docker/aeonlucid/impostor) +### Server -``` -docker run -p 22023:22023/udp aeonlucid/impostor -``` +See the [wiki](https://github.com/AeonLucid/Impostor/wiki/Running-the-server) for instructions on how to set it up. -### Server (Windows / Linux) +## Contributing -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) +If you want to contribute to Impostor, make sure you work on and target the `dev` branch. That is where the latest changes will be. ## License