From: miniduikboot Date: Tue, 9 Jul 2024 20:50:02 +0000 (+0200) Subject: Add new option to full config example X-Git-Tag: v1.10.0~19 X-Git-Url: https://git.deb.at/?a=commitdiff_plain;h=46caeb76c2cec0a5acb98800d1b289ae1f0c9ec1;p=rhonda%2Fimpostor.git Add new option to full config example 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 --- diff --git a/docs/Server-configuration.md b/docs/Server-configuration.md index 4d4c0d6..5a9a4eb 100644 --- a/docs/Server-configuration.md +++ b/docs/Server-configuration.md @@ -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 index 83625b1..0000000 --- a/src/Impostor.Server/config-full.json +++ /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 index 0000000..f24570e --- /dev/null +++ b/src/Impostor.Server/full-config-example.json @@ -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": "" + } +}