remihb · pull · Oct 27, 2019 · Oct 28, 2019 · Oct 30, 2019 · Oct 31, 2019
diff --git a/ANTI_TROLL.md b/ANTI_TROLL.md
@@ -0,0 +1,40 @@
+## Info on experimental anti-troll system
+If activated, a timer is kept for all players. System can be activated in xml config or in the lobby with command:
+\admin troll [0,1]
+
+Timer is increased by the amount of time when
+* a player drives in the wrong way
+* a player moves below a given speed (troll-max-stop-speed)
+
+Timer is not increased when the player is hit or rescued (during animation).
+
+It is decreased (not below 0 obviously) when a player drives in correct direction with at least given speed (troll-min-normal-speed).
+
+If a player's timer exceeds the warning level (troll-warning-time), they get a warning (troll-warn-message). After that the timer is reset.
+If a player got a warning and their timer exceeds the kick level (troll-kick-time), they get kicked.
+Warnings and Kicks are logged.
+
+Config can be controlled in xml file like this:
+
+    <!-- Set values for anti-troll system -->
+    <!-- If true, use anti troll system
+         This can also be controlled with server command:
+         \admin troll [0,1] -->
+    <use-anti-troll-system value="true" />
+    <!-- Warn string to show to player -->
+    <troll-warn-message value="WARNING: You troll, you get kicked !!" />
+    <!-- Warn player that drives backwards or stopps for given time -->
+    <troll-warning-time value="7.0" />
+    <!-- Kick player that drives backwards or stopps for given time -->
+    <troll-kick-time value="10.0" />
+    <!-- Minimum speed in correct direction to decrease wrong-way timer -->
+    <troll-min-normal-speed value="12.0" />
+    <!-- A player going slower than this is considered stopping -->
+    <troll-max-stop-speed value="5.0" />
+
+### Things to note
+* The system can be fooled of course, but it should be a lot harder to troll. Testing would be necessary. However, when I set up a test server, most players coming by just wanted to play normally...
+* The system should not warn or kick weak players who get lost or stuck on obstacles (too quickly). The current configuration values are most probably not yet perfect.
+* Players should probably be informed about the system, because waiting for others (like some pros do when giving weaker players some advice or driving lessons) would be punished, so the system should not be activated in those cases.
+* If a player presses UP-key early, the timer is increased during time punishment at the beginning of the race (1 sec). I don't know how to find out if a player is in that state.
+* **There may still be bugs** (of course)... ;)
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -34,11 +34,11 @@ CMAKE_DEPENDENT_OPTION(USE_IPV6 "Allow create or connect to game server with IPv
 option(USE_SYSTEM_WIIUSE "Use system WiiUse instead of the built-in version, when available." OFF)
 option(USE_SQLITE3 "Use sqlite to manage server stats and ban list." ON)
 
+option(WEB_SUPPORT "Website integration tools" OFF)
 if(APPLE)
     CMAKE_DEPENDENT_OPTION(DLOPEN_MOLTENVK "Use dlopen to load MoltenVK for Apple." ON
         "NOT IOS;NOT SERVER_ONLY" OFF)
 endif()
-
 CMAKE_DEPENDENT_OPTION(USE_CRYPTO_OPENSSL "Use OpenSSL instead of MbedTLS for cryptography in STK." ON
     "NOT USE_SWITCH;NOT WIN32" OFF)
 CMAKE_DEPENDENT_OPTION(BUILD_RECORDER "Build opengl recorder" ON
@@ -475,6 +475,11 @@ if(USE_SQLITE3)
     endif()
 endif()
 
+# Web support
+if(WEB_SUPPORT)
+    add_definitions(-DENABLE_WEB_SUPPORT)
+endif()
+
 # Set some compiler options
 if(UNIX OR MINGW)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=gnu++0x")

diff --git a/FORK_CHANGES.md b/FORK_CHANGES.md
@@ -0,0 +1,94 @@
+This page lists the major changes of this repository compared to standard STK code, as of April 2024. Most changes (sadly, not all of them) here are implemented as options, that is, you can disable them and return to standard behaviour.
+
+You can find more information such as explanations and minor details in [wiki](https://github.com/kimden/stk-code/wiki/). It will be probably filled with even more data in the future.
+
+## Improved Grand Prix mode
+
+* Server doesn't become private
+* Players can pick karts, join or leave
+* Custom scoring systems
+* Custom teams (up to 9)
+* Standings ingame (short) and in the lobby (longer)
+* Anti-troll and team hit punishment systems, by Heuchi1
+* Allows to shuffle the starting grid every race
+
+## Records, replays and stats
+
+* Game results for racing and battle modes can be saved to the database, together with game settings and kart statistics
+* Public or private record tables can be created using that information
+* Ghost replays can be recorded on servers if players agree
+* Players who beat server records can be notified (includes separation of times set with different config files)
+* Maximum replay size is increased
+
+## Chat
+
+* Private chat with an arbitrary set of players
+* Teamchat during CTF and soccer which works both ingame and in the lobby
+* Messages are never logged, even by the bots (though they pass through the server code)
+
+## Game configuration, available maps and karts, playing restrictions
+
+* Game length can be set to a fixed value, or to a certain multiple of default lap number, or to be chosen ingame
+* Game direction can be set to forward or reverse, or to be chosen ingame
+* For karts and maps, the next game can be customized so that the set of karts/maps available for choice is fixed, or defined by a certain algorithm (including "you have to play this track", "select from $N$ random maps from this set", "you can choose either Adiumy, or whatever is given to you by random of Suzanne and Konqi")
+* The same is true for any number of next games, and the server can be set to repeat the customization every number of games
+
+All of the above settings can be changed arbitrarily when the server already runs, or in the config before the server starts.
+
+* Servers can be started with other powerup.xml or kart_characteristics.xml files being specified
+* It's possible for a server to force certain maps for players to join the server or to join the game, or vice versa, disable certain maps (or all but a certain set of maps). There are various commands to find out which addons you (or other players) have or don't have, to make it easy to deal with the above
+* The default setting of number of playable slots (playable places on the server) can be changed with a command
+* If the player is unable to play due to imposed restrictions (lacking maps, being out of playable slots), that player doesn't affect the set of available maps, and is given the hourglass icon.
+
+## Command manager
+
+Command manager is an entity made to manipulate all existing server commands easier. It supports:
+
+* commands with voting
+* text commands / commands reading external files
+* auth commands
+* setting permissions for commands without recompiling the code and/or depending on server
+* subcommands and different permissions for them
+* fixing errors in arguments (usernames, map names)
+* showing available commands depending on permissions
+* documentation for all commands via `/help`
+* huge number of new commands
+
+All the commands and their descriptions are available in `data/commands.xml`. This file is also used to generate output for `/commands` and `/help`.
+
+## Moderation and permissions
+
+* It's possible to disable kicks attempted by the crowned player
+* If a player kicks another player, the fact of the kick can be stored in the database table with reports
+* Inactive players can be kicked automatically from the lobby too, not only from the game
+* A hammer mode is added: players having a password can get a hammer, then they can change server settings and kick players
+* There are commands to ban (or unban) a player temporary from a single server by username, as opposed to standard bans which are applied to all servers using the same database, and are usually banning by online id or IP address
+* Players are allowed to report something to server owner without reporting other people
+* Starting the game can be allowed or forbidden using a command
+
+## Game modes and their improvements
+
+These are not implemented as separate modes, but are rather additions to functionality of existing modes:
+
+* **Soccer tournament** mode: for hosting matches of several soccer games. The rules, the number of games and their duration, allowed arenas, tournament teams can be loaded from a config file. Referees have multiple commands to control the game flow
+* **Gnu Elimination** mode: every race, the last (or quitting) non-eliminated player gets eliminated, and eliminated players use the same kart chosen in advance. The last standing player wins
+
+Separate changes for modes:
+
+* Soccer games produce a log of all goals / actions that happened (originally made for tournament mode, but can be used without it too), if the score is edited using tournament commands, the game shows it as a message after each goal and at the end
+* FFA and CTF scores are preserved per username during the game, so that leaving the game is not punished
+
+## Other features
+
+* You can allow only the crowned player to play (speedrun server), or no one at all (chat server)
+* Minor `/spectate` changes (you can invoke it ingame, game doesn't start with everyone spectating)
+* For a configurable server, you can specify which exact difficulties and modes are allowed
+* Players can send a message to the server owner (without reporting anyone else), and the server owner can send one-time messages to specific players
+* For private servers, players can be whitelisted so that they can enter any password to join
+* Different strategies to determine who scored a goal (allowing or forbidding own goals)
+* `max-moveable-objects` is changed to 30 to allow tracks like `addon_bowling` to work
+* Server can be customized to reset or preserve many settings like game mode, game length, ..., when everyone leaves it
+* Server git version and whether it's modified is shown in `/version`
+* Server console allows sending arbitrary messages to players
+* Supported player categories aka sets of players (for now only displaying their names, and some minor usage)
+* Minor additions in StringUtils used in typo fixing and string parsing
diff --git a/NETWORKING.md b/NETWORKING.md
@@ -25,7 +25,7 @@ Than you can just run:
 It will create that xml configuration file if not found in current directory, you can type `quit` in terminal, than you can edit that file for further configuration as required.
 ` --network-console` should not be used if you run supertuxkart server later with systemd service, see issue [#4299](https://github.com/supertuxkart/stk-code/issues/4299).
 
-The current server configuration xml looks like this:
+The current server configuration xml looks like this (this is only an example, just copying and running server with this config file makes some tracks obligatory and some unplayable, please read carefully):
 ```xml
 <?xml version="1.0"?>
 <server-config version="6" >
@@ -60,9 +60,12 @@ The current server configuration xml looks like this:
     <!-- Password for private server, leave empty for a public server. -->
     <private-server-password value="" />
 
-    <!-- Message of today shown in lobby, you can enter encoded XML words here or a file.txt and let STK load it. -->
+    <!-- Message of today shown in lobby, you can enter here encoded XML words or a .txt file and let STK load it. -->
     <motd value="" />
 
+    <!-- Help message shown after sending /help. You can enter here the message or a .txt file and let STK load it. -->
+    <help value="" />
+
     <!-- If this value is set to false, the server will ignore chat messages from all players. -->
     <chat value="true" />
 
@@ -92,13 +95,43 @@ 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" />
+
+    <!-- If this value is set to true, a message is send to everybody if a player makes a teammate explode. -->
+    <show-teammate-hits value="false" />
+
+    <!-- Punish teammate hits? If set to true players get an anvil when they hit teammates. -->
+    <teammate-hit-mode value="false" />
 
     <!-- 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" />
 
+    <!-- Clients below this value will be rejected from joining this server. It's determined by number of addon karts in client -->
+    <addon_karts_threshold value="0" />
+
+    <!-- Clients below this value will be rejected from joining this server. It's determined by number of addon tracks in client -->
+    <addon_tracks_threshold value="0" />
+
+    <!-- Clients below this value will be rejected from joining this server. It's determined by number of addon arenas in client -->
+    <addon_arenas_threshold value="0" />
+
+    <!-- Clients below this value will be rejected from joining this server. It's determined by number of addon soccer fields in client -->
+    <addon_soccers_threshold value="0" />
+
+    <!-- Tracks needed to enter the server, leave empty for no restriction. -->
+    <must-have-tracks value="hacienda xr591 addon_animtrack_1 minigolf" />
+
+    <!-- List of tracks that can be played on a server, leave empty for no restriction or put 'not' before the list to name tracks that cannot be played. -->
+    <only-played-tracks value="not abyss snowtuxpeak addon_minigolf" />
+
+    <!-- Use fixed lap count, negative or zero to disable. -->
+    <fixed-lap-count value="-1" />
+
+    <!-- If this value is set to true, players and the server must have at least one common official track. -->
+    <official-tracks-needed value="true" />
+
     <!-- 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" />
 
@@ -117,6 +150,9 @@ The current server configuration xml looks like this:
     <!-- 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" />
 
+    <!-- Description of modes and difficulties that can be set on a configurable server. Doesn't affect initial mode and doesn't affect unconfigurable servers. Use the format "d0123 m012345678". -->
+    <available-modes value="d0123 m012345678" />
+
     <!-- If true, players can live join or spectate the in-progress game. Currently live joining is only available if the current game mode used in server is FFA, CTF or soccer, also official-karts-threshold will be made 1.0. If false addon karts will use their original hitbox other than tux, all players having it restriction applies. -->
     <live-spectate value="true" />
 
@@ -192,9 +228,57 @@ The current server configuration xml looks like this:
     <!-- If true this server will auto add / remove AI connected with network-ai=x, which will kick N - 1 bot(s) where N is the number of human players. Only use this for non-GP racing server. -->
     <ai-handling value="false" />
 
+    <!-- If true no one can start a race and everyone should use the server for sleeping/chatting only. -->
+    <sleeping-server value="false" />
+
+    <!-- IP that should be used to connect to a server, set 0 for a default IP. You need this only if the server's IP shouldn't be used for some reason (e.g. blocking) and there is another IP ('good') that points to the same server. In this case, you should write a good IP here as a number. Only IPv4 is supported. -->
+    <false-ip value="0" />
+
+    <!-- When true, stores race results in a separate table for each server. -->
+    <store-results value="false" />
+
+    <!-- When non-empty, server is telling whether a player has beaten a server record, records are taken from the table specified in this field. So it can be the results table for this server or for all servers hosted on the machine.-->
+    <records-table-name value="" />
+
+    <!-- When true, stores the info about each forced kick in a database (if it exists). -->
+    <track-kicks value="false" />
+
+    <!-- When true, the server allows changing teams freely. -->
+    <free-teams value="false" />
+
+    <!-- When true, the server has the functionality to host soccer tournaments. Rules may change so better ask STK players about the actual rules. -->
+    <soccer-tournament value="false" />
+
+    <!-- List of players and judges. Use the format "R red red red B blue blue blue J judge judge" where the category is preceded by its letter. Categories can be empty or absent and can go in any order. -->
+    <soccer-tournament-players value="" />
+
+    <!-- A string given to a peer if it has incompatible data, so that it can know why it cannot enter, empty to disable. -->
+    <incompatible-advice value="Well, you have incompatible data!" />
+
+    <!-- If true and no track is selected, then an addon track can be picked. -->
+    <random-selects-addons value="false" />
+
+    <!-- If non-empty, these tracks are played in the order until the list ends. Can be useful for grands prix. -->
+    <tracks-queue value="" />
+
+    <!-- A custom Grand Prix scoring system to be used, empty for default. -->
+    <grand-prix-scoring value="" />
+
+    <!-- For a private server, a list of players who can enter with any password. Works only for online accounts. -->
+    <white-list value="kimden" />
+
+    <!-- If true, all mobile peers get a corresponding icon into the name. -->
+    <expose-mobile value="true" />
+
+    <!-- Specifies how to count own goals: standard - last touching player is counted, no-own-goals - last touching player of scoring team is counted if existing, advanced - as standard for now. -->
+    <soccer-goals-policy value="standard" />
+
     <!-- If true this server will allow AI instance to be connected from anywhere. (other than LAN network only) -->
     <ai-anywhere value="false" />
 
+    <!-- If true, the server owner can kick players, either via the UI button or using /kick command. -->
+    <kicks-allowed value="true" />
+
 </server-config>
 
 ```
@@ -265,7 +349,12 @@ CREATE TABLE IF NOT EXISTS (table name above)
     os TEXT NOT NULL, -- Operating system of the host
     connected_time TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, -- Time when connected
     disconnected_time TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, -- Time when disconnected (saved when disconnected)
-    ping INTEGER UNSIGNED NOT NULL DEFAULT 0 -- Ping of the host
+    ping INTEGER UNSIGNED NOT NULL DEFAULT 0, -- Ping of the host
+    packet_loss INTEGER NOT NULL DEFAULT 0, -- Mean packet loss count from ENet (saved when disconnected)
+    addon_karts_count INTEGER UNSIGNED NOT NULL DEFAULT 0, -- Number of addon karts of the host
+    addon_tracks_count INTEGER UNSIGNED NOT NULL DEFAULT 0, -- Number of addon tracks of the host
+    addon_arenas_count INTEGER UNSIGNED NOT NULL DEFAULT 0, -- Number of addon arenas of the host
+    addon_soccers_count INTEGER UNSIGNED NOT NULL DEFAULT 0 -- Number of addon soccers of the host
 ) WITHOUT ROWID;
 ```
 
@@ -293,7 +382,7 @@ CREATE TABLE IF NOT EXISTS (table name above)
 
 If you want to see flags and readable names of countries in the above views, you need to initialize `v(server database version)_countries` table, check [this script](tools/generate-countries-table.py).
 
-For IPv4 and online ID ban list, player reports or IP mapping, you need to create one yourself:
+For IPv4 and online ID ban list, player reports or IP mapping (in case your server doesn't communicate with STK addons server, which can do IP mapping instead of your server), you need to create one yourself:
 ```sql
 CREATE TABLE ip_ban
 (