From 9d520bf9a368005b5641f920f54142834d0900c9 Mon Sep 17 00:00:00 2001 From: AeonLucid Date: Mon, 26 Oct 2020 04:39:18 +0100 Subject: [PATCH] Move options to the top --- docs/Server-configuration.md | 58 ++++++++++++++++++------------------ 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/Server-configuration.md b/docs/Server-configuration.md index 2896b23..f8e3774 100644 --- a/docs/Server-configuration.md +++ b/docs/Server-configuration.md @@ -2,6 +2,34 @@ Some information about all the possible configurations. Click [here](https://github.com/AeonLucid/Impostor/blob/master/src/Impostor.Server/config.full.json) to see all the possible config options. +## Options + +### Server + +| Key | Default | Description | +|-|-|-| +| **PublicIp** | `127.0.0.1` | This needs to the IPv4 address of the server, what you give to others to connect. You can find the your IPv4 address [here](http://whatismyip.host/). | +| **PublicPort** | `22023` | The public port of the server, what you give to others to connect. Usually `22023`. | +| **ListenIp** | `0.0.0.0` | The network interface to listen on. If you do not know what to put here, use `0.0.0.0`. | +| **ListenPort** | `22023` | The listen port of the server, usually `22023`. | + +### AntiCheat + +| Key | Default | Value | +|-|-|-| +| **BanIpFromGame** | `true` | When a player is caught hacking, he will be kicked from the server. If this value is set to `true`, the player will also be banned and can not rejoin that specific game. | + +### ServerRedirector + +| Key | Default | Value | +|-|-|-| +| **Enabled** | `false` | Whether the server runs in multi-node setup. If this is `false`, all other options in this section do not have any effect. | +| **Master** | `false` | Whether the current server is a master. A master is responsible for redirecting clients to nodes | +| **Locator** | | Fill in either `Redis` or `UdpMasterEndpoint` to choose which method to use for locating other nodes. This must be the same across all servers. | +| **>Redis** | | Format `127.0.0.1.6379`, you can also use a password like so: `127.0.0.1.6379,password=value`. | +| **>UdpMasterEndpoint** | | On the master, this value acts as a listen ip and port. On a node, this should be the public ip and port of the master. Format `127.0.0.1:32320`. | +| **Nodes** | | An array containing public ips and ports of nodes. Only needs to be set on the master. See above for an example. | + ## Config providers ### File @@ -46,32 +74,4 @@ IMPOSTOR_ServerRedirector__Nodes__0__Ip=127.0.0.1 IMPOSTOR_ServerRedirector__Nodes__0__Port=22024 IMPOSTOR_ServerRedirector__Nodes__1__Ip=127.0.0.1 IMPOSTOR_ServerRedirector__Nodes__1__Port=22025 -``` - -## Options - -### Server - -| Key | Default | Description | -|-|-|-| -| **PublicIp** | `127.0.0.1` | This needs to the IPv4 address of the server, what you give to others to connect. You can find the your IPv4 address [here](http://whatismyip.host/). | -| **PublicPort** | `22023` | The public port of the server, what you give to others to connect. Usually `22023`. | -| **ListenIp** | `0.0.0.0` | The network interface to listen on. If you do not know what to put here, use `0.0.0.0`. | -| **ListenPort** | `22023` | The listen port of the server, usually `22023`. | - -### AntiCheat - -| Key | Default | Value | -|-|-|-| -| **BanIpFromGame** | `true` | When a player is caught hacking, he will be kicked from the server. If this value is set to `true`, the player will also be banned and can not rejoin that specific game. | - -### ServerRedirector - -| Key | Default | Value | -|-|-|-| -| **Enabled** | `false` | Whether the server runs in multi-node setup. If this is `false`, all other options in this section do not have any effect. | -| **Master** | `false` | Whether the current server is a master. A master is responsible for redirecting clients to nodes | -| **Locator** | | Fill in either `Redis` or `UdpMasterEndpoint` to choose which method to use for locating other nodes. This must be the same across all servers. | -| **>Redis** | | Format `127.0.0.1.6379`, you can also use a password like so: `127.0.0.1.6379,password=value`. | -| **>UdpMasterEndpoint** | | On the master, this value acts as a listen ip and port. On a node, this should be the public ip and port of the master. Format `127.0.0.1:32320`. | -| **Nodes** | | An array containing public ips and ports of nodes. Only needs to be set on the master. See above for an example. | \ No newline at end of file +``` \ No newline at end of file -- 2.39.5