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

Update documentation

Browse Source
This commit is contained in:
Benau 2018-12-07 01:37:16 +08:00
parent 8a11fae026
commit 76406db939
2 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
NETWORKING.md
View File

@ -74,6 +74,12 @@ The current server configuration xml looks like this:
<!-- Time to wait before entering kart selection screen if satisfied min-start-game-players below for owner less or ranked server. -->
<start-game-counter value="60" />
<!-- Clients below this value will be rejected from joining this server. It's determined by number of official karts in client / number of official karts in server -->
<official-karts-threshold value="1" />
<!-- Clients below this value will be rejected from joining this server. It's determined by number of official tracks in client / number of official tracks in server, setting this value too high will prevent android players from joining this server, because STK android apk has some official tracks removed. -->
<official-tracks-threshold value="0.7" />
<!-- Only auto start kart selection when number of connected player is larger than or equals this value, for owner less or ranked server, after start-game-counter reaches 0. -->
<min-start-game-players value="2" />
@ -89,6 +95,9 @@ The current server configuration xml looks like this:
<!-- Server will submit ranking to stk addons server for linear race games, you require permission for that. validating-player, auto-end, strict-player and owner-less will be turned on. -->
<ranked value="false" />
<!-- If true, the server owner can config the difficulty and game mode in the GUI of lobby. This option cannot be used with owner-less or grand prix server, and will be automatically turned on if the server was created using the in-game GUI. The changed difficulty and game mode will not be saved in this config file. -->
<server-configurable value="false" />
<!-- Time in seconds when a flag is dropped a by player in CTF returning to its own base. -->
<flag-return-timemout value="20" />
@ -116,6 +125,9 @@ The current server configuration xml looks like this:
<!-- Kick players whose ping is above max-ping. -->
<kick-high-ping-players value="false" />
<!-- Kick idle player which has no network activity to server for more than some seconds during game, unless he has finished the race. Negative value to disable, and this option will always be disabled for LAN server. -->
<kick-idle-player-seconds value="60" />
<!-- ip: IP in X.X.X.X/Y (CIDR) format for banning, use Y of 32 for a specific ip, expired-time: unix timestamp to expire, -1 (uint32_t max) for a permanent ban. -->
<server-ip-ban-list>
<ban ip="0.0.0.0/0" expired-time="0"/>

5
src/network/server_config.hpp
View File

@ -223,10 +223,11 @@ namespace ServerConfig
SERVER_CFG_PREFIX BoolServerConfigParam m_server_configurable
SERVER_CFG_DEFAULT(BoolServerConfigParam(false, "server-configurable",
"If true, the server owner can config the game mode and difficulty in "
"If true, the server owner can config the difficulty and game mode in "
"the GUI of lobby. This option cannot be used with owner-less or "
"grand prix server, and will be automatically turned on if the server "
"was created using the in-game GUI."));
"was created using the in-game GUI. The changed difficulty and game "
"mode will not be saved in this config file."));
SERVER_CFG_PREFIX FloatServerConfigParam m_flag_return_timemout
SERVER_CFG_DEFAULT(FloatServerConfigParam(20.0f, "flag-return-timemout",