ilikecats/stk-code_catmod
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update network documentation

Browse Source
This commit is contained in:
Benau 2019-01-07 14:46:34 +08:00
parent 9d612455b3
commit 307194e482
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
NETWORKING.md
View File

@ -86,7 +86,7 @@ The current server configuration xml looks like this:
<!-- Automatically end linear race game after 1st player finished for some time (currently his finished time * 0.25 + 15.0). -->
<auto-end value="false" />
<!-- Enable team choosing in lobby in team game (soccer and CTF). If owner-less is enabled, than this option is always disabled. -->
<!-- Enable team choosing in lobby in team game (soccer and CTF). If owner-less is enabled and live-players is not enabled, than this option is always disabled. -->
<team-choosing value="true" />
<!-- If strict-players is on, no duplicated online id or split screen players are allowed, which can prevent someone using more than 1 network AI with this server. -->
@ -119,10 +119,10 @@ The current server configuration xml looks like this:
<!-- Value used by server to automatically estimate each game time. For races, it decides the lap of each race in network game, if more than 0.0f, the number of lap of each track vote in linear race will be determined by max(1.0f, auto-game-time-ratio * default lap of that track). For soccer if more than 0.0f, for time limit game it will be auto-game-time-ratio * soccer-time-limit in UserConfig, for goal limit game it will be auto-game-time-ratio * numgoals in UserConfig, -1 to disable for all. -->
<auto-game-time-ratio value="-1" />
<!-- Maximum ping allowed for a player (in ms). -->
<!-- Maximum ping allowed for a player (in ms), it's recommended to use default value if live-players is on. -->
<max-ping value="300" />
<!-- Tolerance of jitter in network allowed (in ms). -->
<!-- Tolerance of jitter in network allowed (in ms), it's recommended to use default value if live-players is on. -->
<jitter-tolerance value="100" />
<!-- Kick players whose ping is above max-ping. -->
@ -146,7 +146,6 @@ The current server configuration xml looks like this:
</server-config>
```
At the moment STK has a list of STUN servers for NAT penetration which allows players or servers behind a firewall or router to be able to connect to each other, but in case it doesn't work, you have to manually disable the firewall or port forward the port(s) used by the STK.

6
src/network/server_config.hpp
View File

@ -285,11 +285,13 @@ namespace ServerConfig
SERVER_CFG_PREFIX IntServerConfigParam m_max_ping
SERVER_CFG_DEFAULT(IntServerConfigParam(300, "max-ping",
"Maximum ping allowed for a player (in ms)."));
"Maximum ping allowed for a player (in ms), it's recommended to use "
"default value if live-players is on."));
SERVER_CFG_PREFIX IntServerConfigParam m_jitter_tolerance
SERVER_CFG_DEFAULT(IntServerConfigParam(100, "jitter-tolerance",
"Tolerance of jitter in network allowed (in ms)."));
"Tolerance of jitter in network allowed (in ms), it's recommended to "
"use default value if live-players is on."));
SERVER_CFG_PREFIX BoolServerConfigParam m_kick_high_ping_players
SERVER_CFG_DEFAULT(BoolServerConfigParam(false,