]> git.deb.at Git - rhonda/impostor.git/commitdiff
Add new option to full config example
authorminiduikboot <mini@duikbo.at>
Tue, 9 Jul 2024 20:50:02 +0000 (22:50 +0200)
committerminiduikboot <mini@duikbo.at>
Sat, 27 Jul 2024 15:05:34 +0000 (17:05 +0200)
Some people were confused by config-full.json, thinking that this file
should be edited too. This is not the case and the values in this file
don't apply as it was only meant as an example, so rename the file to
make that more clear.

Also update this file to add the options from the Modular Anticheat

docs/Server-configuration.md
src/Impostor.Server/config-full.json [deleted file]
src/Impostor.Server/full-config-example.json [new file with mode: 0644]

index 4d4c0d60ae12b1c455ad533e15b413587474834f..5a9a4eb08705a50e0676f3d830fafb6f4642fc84 100644 (file)
@@ -1,6 +1,6 @@
 # Server configuration
 
-Some information about all the possible configurations. Click [here](https://github.com/Impostor/Impostor/blob/master/src/Impostor.Server/config-full.json) to see all the possible config options.
+Some information about all the possible configurations. Click [here](https://github.com/Impostor/Impostor/blob/master/src/Impostor.Server/full-config-example.json) to see all the possible config options.
 
 ## Options
 
@@ -39,7 +39,6 @@ Impostor has an Anticheat that makes it possible to kick cheaters from games aut
 | **EnableOwnershipChecks**  | `true`    | Enables checks that check if players are allowed to perform a certain action on themself or another player.                                                                                                         |
 | **EnableRoleChecks**       | `true`    | Enables checks that check if players have the correct role when performing certain role abilities like venting or murdering.                                                                                        |
 | **EnableTargetChecks**     | `true`    | Enables checks that check if certain packets to everyone that should only have been sent to certain players or vice versa. This includes sending votes or network objects.                                          |
-
 | **ForbidProtocolExtensions** | `true`  | If disabled allows players to send network packets that go beyond the network packets sent by the vanilla game. This is necessary for most mods that need all players to install it.                                |
 
 ### Compatibility
@@ -99,7 +98,7 @@ Other Serilog sinks are also supported, but are out of scope for this documentat
 
 ### File
 
-The simplest option to configure is by using the `config.json` file next to the server executable. For all possible options see the [config-full.json](https://github.com/Impostor/Impostor/blob/dev/src/Impostor.Server/config-full.json) file.
+The simplest option to configure is by using the `config.json` file next to the server executable. For all possible options see the [full-config-example.json](https://github.com/Impostor/Impostor/blob/master/src/Impostor.Server/full-config-example.json) file.
 
 ### Environment variables
 
diff --git a/src/Impostor.Server/config-full.json b/src/Impostor.Server/config-full.json
deleted file mode 100644 (file)
index 83625b1..0000000
+++ /dev/null
@@ -1,29 +0,0 @@
-{
-  "Server": {
-    "PublicIp": "127.0.0.1",
-    "PublicPort": 22023,
-    "ListenIp": "0.0.0.0",
-    "ListenPort": 22023
-  },
-  "HttpServer": {
-    "Enabled": true,
-    "ListenIp": "0.0.0.0",
-    "ListenPort": 22023
-  },
-  "AntiCheat": {
-    "Enabled": true,
-    "BanIpFromGame": true
-  },
-  "Timeout": {
-    "SpawnTimeout": 2500,
-    "ConnectionTimeout": 2500
-  },
-  "Compatibility": {
-    "AllowFutureGameVersions": false,
-    "AllowVersionMixing": false
-  },
-  "Debug": {
-    "GameRecorderEnabled": true,
-    "GameRecorderPath": ""
-  }
-}
diff --git a/src/Impostor.Server/full-config-example.json b/src/Impostor.Server/full-config-example.json
new file mode 100644 (file)
index 0000000..f24570e
--- /dev/null
@@ -0,0 +1,38 @@
+{
+  "Server": {
+    "PublicIp": "127.0.0.1",
+    "PublicPort": 22023,
+    "ListenIp": "0.0.0.0",
+    "ListenPort": 22023
+  },
+  "HttpServer": {
+    "Enabled": true,
+    "ListenIp": "0.0.0.0",
+    "ListenPort": 22023
+  },
+  "AntiCheat": {
+    "Enabled": true,
+    "BanIpFromGame": true,
+    "AllowCheatingHosts": "Never",
+    "EnableGameFlowChecks": true,
+    "EnableMustBeHostChecks": true,
+    "EnableColorLimitChecks": true,
+    "EnableNameLimitChecks": true,
+    "EnableOwnershipChecks": true,
+    "EnableRoleChecks": true,
+    "EnableTargetChecks": true,
+    "ForbidProtocolExtensions": true
+  },
+  "Timeout": {
+    "SpawnTimeout": 2500,
+    "ConnectionTimeout": 2500
+  },
+  "Compatibility": {
+    "AllowFutureGameVersions": false,
+    "AllowVersionMixing": false
+  },
+  "Debug": {
+    "GameRecorderEnabled": true,
+    "GameRecorderPath": ""
+  }
+}