Update README

diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
index 68208c37bf5e8dd0b08d9b77f4d0c607e148893d..e6f66d1b8280906fe98820f4caf475295c05ec18 100644 (file)
--- a/.github/workflows/docker.yml
+++ b/.github/workflows/docker.yml
@@ -1,13 +1,17 @@
 name: Docker
 
 on:
-  schedule:
-    - cron: '0 10 * * *'
   push:
-    branches: [ master, dev ]
+    branches: dev
+    paths:
+      - 'src/**'
+      - '.gitmodules'
     tags:
       - 'v*.*.*'
   pull_request:
+    paths:
+      - 'src/**'
+      - '.gitmodules'
 
 jobs:
   push_to_registry:
@@ -23,14 +27,12 @@ jobs:
         run: |
           DOCKER_IMAGE=aeonlucid/impostor
           VERSION=noop
-          if [ "${{ github.event_name }}" = "schedule" ]; then
-            VERSION=nightly
-          elif [[ $GITHUB_REF == refs/tags/* ]]; then
+          if [[ $GITHUB_REF == refs/tags/* ]]; then
             VERSION=${GITHUB_REF#refs/tags/}
           elif [[ $GITHUB_REF == refs/heads/* ]]; then
             VERSION=$(echo ${GITHUB_REF#refs/heads/} | sed -r 's#/+#-#g')
-            if [ "${{ github.event.repository.default_branch }}" = "$VERSION" ]; then
-              VERSION=edge
+            if [ "${{ github.event.repository.default_branch }}" = "dev" ]; then
+              VERSION=nightly
             fi
           elif [[ $GITHUB_REF == refs/pull/* ]]; then
             VERSION=pr-${{ github.event.number }}

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index ad319c22d39fe50499a3c24c7d3a0ca24e69c8fd..226906364ae0e8d0247ed756e3a2494e3e0f60c3 100644 (file)
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -3,8 +3,14 @@ name: Build
 on:
   push:
     branches: [ master, dev ]
+    paths:
+      - 'src/**'
+      - '.gitmodules'
   pull_request:
     branches: [ master, dev ]
+    paths:
+      - 'src/**'
+      - '.gitmodules'
 
 jobs:
   build:

diff --git a/README.md b/README.md
index 6d113a64b490a0f94f12196973e49d44f14f7430..e330f2673dad25d80092483e0257644f184dbcd0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,25 +1,58 @@
-# AmongUsServer
+# Impostor
 
-## Server details
+Impostor is one of the first **Among Us** private servers, written in C#.
 
-These are official server IPs.
+The latest version supported is `2020.9.9`, both desktop and mobile.
 
-### Matchmaking servers
+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.
 
-| Name | Region | IP | Port | Hardcoded |
-|-|-|-|-|-|
-| Master-1 | North America | 50.116.1.42 | 22023 | True | 
-| Master-2 | North America | 104.237.135.186 | 22023 | True | 
-| Master-3 | North America | 45.79.40.75 | 22023 | True | 
-| Asia-Master-1 | Asia | 139.162.111.196 | 22023 | True | 
-| Asia-Master-2 | Asia | 172.104.96.99 | 22023 | False |
-| Europe-Master-1 | Europe | 172.105.251.170 | 22023 | True | 
-| Europe-Master-2 | Europe | 172.105.249.25 | 22023 | False | 
+[Discord server for Impostor](https://discord.gg/Mk3w6Tb)
 
-### Ping servers
+## Features
 
-| Region | IP |
-|-|-|
-| North America | 66.175.220.120 |
-| Asia | 139.162.111.196 |
-| Europe | 172.105.251.170 |
\ No newline at end of file
+Almost all standard features are implemented at this moment, except for public games. It is already possible to host and play private games.
+
+- [x] Create game
+- [x] Join game
+- [x] Start game
+- [ ] Find game
+- [x] V1 GameCodes (AAAA)
+- [x] V2 GameCodes (AAAAAA)
+- [x] Kick player
+- [x] Ban player
+- [ ] Server redirection
+- [ ] Server reselect
+
+## Installation
+
+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
+
+### Server (Docker)
+
+![Docker Image](https://img.shields.io/docker/v/aeonlucid/impostor?sort=semver)
+![Docker Image](https://img.shields.io/docker/v/aeonlucid/impostor/edge)
+
+```
+docker run -p 22023:22023/udp aeonlucid/impostor
+```
+
+### Server (Windows / Linux)
+
+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)
+
+## License
+
+This software is distributed under the **GNU GLPv3** License.
+
+## Credits
+
+- [willardf/Hazel-Networking](https://github.com/willardf/Hazel-Networking)
\ No newline at end of file

diff --git a/src/Impostor.Server/Exceptions/AmongUsException.cs b/src/Impostor.Server/Exceptions/AmongUsException.cs
index 0d5ff20343ab4b5c480f1a5debfc8a00bb4ccf4f..2e622f2f18298b521b919e1b9dc3bddce2a4807b 100644 (file)
--- a/src/Impostor.Server/Exceptions/AmongUsException.cs
+++ b/src/Impostor.Server/Exceptions/AmongUsException.cs
@@ -13,11 +13,11 @@ namespace Impostor.Server.Exceptions
         {
         }
 
-        public AmongUsException(string? message) : base(message)
+        public AmongUsException(string message) : base(message)
         {
         }
 
-        public AmongUsException(string? message, Exception? innerException) : base(message, innerException)
+        public AmongUsException(string message, Exception innerException) : base(message, innerException)
         {
         }
     }