| advertDelay (preset setting) | |
| Explicit name | Advert delay |
| Description | Delay in minutes between automatic advert messages (refer to advertMsg). A value of 0 disables advert system. |
| Format / Allowed values | Integer |
| Default value | 15 |
| advertMsg (preset setting) | |
| Explicit name | Advert message |
| Description | Message sent to battle lobby every advertDelay minutes (lines are separated by character '|'). Advert messages aren't sent when a game is in progress or when noone is in battle lobby. This is a special preset setting: it cannot be changed using !set command, you have to use the !advert command instead. |
| Format / Allowed values | <null> (functionality disabled) Any string |
| Default value | <null> |
| allowGhostMaps (preset setting) | |
| Explicit name | Allow ghost maps |
| Description | If enabled and if dedicated Spring server is used (see springServerType), ghost maps will be available for "!list maps", "!set map", and "!map" commands (and automatic map rotation). A ghost map is a map which isn't available locally on the server, but whose hash has been learned (refer to autoLearnMaps and/or "!learnMaps" command). Only the "choose in game" start position type is allowed for such maps. Like normal maps, ghost maps still have to be included in current map list to be available (refer to mapList). |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 0 |
| allowMapOptionsValues (preset setting) | |
| Explicit name | Allow map options values |
| Description | When a map option isn't defined in current battle preset, it takes the default value provided by the map. The other allowed values for such a map option depend on the "allowMapOptionsValues" preset setting: If disabled, the map options that aren't defined in current battle preset cannot be modified. If enabled, the map options that aren't defined in current battle preset can take the allowed values provided by the map. |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| allowModOptionsValues (preset setting) | |
| Explicit name | Allow mod options values |
| Description | When a mod option isn't defined in current battle preset, it takes the default value provided by the mod. The other allowed values for such a mod option depend on the "allowModOptionsValues" preset setting: If disabled, the mod options that aren't defined in current battle preset cannot be modified. If enabled, the mod options that aren't defined in current battle preset can take the allowed values provided by the mod. |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| allowedLocalAIs (preset setting) | |
| Explicit name | Allowed local AIs |
| Description | This is the list of allowed AIs for local bots. Only these AIs are allowed for !addbot command. (local bots require Spring headless, see springServerType) |
| Format / Allowed values | [<ai>[;<ai2>...]] where <ai> is the exact name of the AI (example: "Chicken: Normal") |
| Default value | E323AI;HughAI;KAIK;RAI |
| autoAddBotNb (preset setting) | |
| Explicit name | Auto-add bot number |
| Description | This number is used by SPADS to determine the number of local bots to add/remove automatically, according to following rules: - If "humans vs bots" mode is selected (i.e., nbTeams is set to 1), then "autoAddBotNb" is the total number of bots which must be in the bot team. - Else if FFA mode is selected (i.e., teamSize is set to 1), then "autoAddBotNb" is the minimum number of players or bots to maintain in the battle room - Else if TeamFFA mode is selected (i.e., minTeamSize is different than 1), then "autoAddBotNb" is the minimum number of teams to fill with minTeamSize (or teamSize if minTeamSize is 0) players and bots - Else, "autoAddBotNb" is the minimum number of players or bots to maintain in each team Auto added bots are taken from localBots and always obey the maxLocalBots and maxBots limits. (local bots require Spring headless, see springServerType) |
| Format / Allowed values | Integer |
| Default value | 0 |
| autoBalance (preset setting) | |
| Explicit name | Auto-balance mode |
| Description | Specifies if and when teams must be automatically balanced. When autoBalance is set to "on", teams are automatically balanced as soon as all following conditions are fulfilled: - there are at least minPlayers players in the battle lobby - the target number of players (1) is reached - teams can be made even (2) The "advanced" auto-balance mode works in the same way, except that it doesn't check if the target number of players is reached. It auto-balances as soon as all other conditions are fulfilled. (1) The target number of players is computed from nbTeams, teamSize, and nbPlayerById (target number of players = nbTeams * teamSize * nbPlayerById) (2) i.e. current number of players in battle lobby is a multiple of nbTeams |
| Format / Allowed values | off: auto-balance disabled on: auto-balance enabled advanced: auto-balance enabled even if target number of players isn't reached |
| Default value | advanced |
| autoBlockBalance (preset setting) | |
| Explicit name | Auto-block balance |
| Description | If enabled, SPADS will prevent players from changing their ID/team once teams have been balanced. |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| autoBlockColors (preset setting) | |
| Explicit name | Auto-block colors |
| Description | If enabled, SPADS will prevent players from changing their color once colors have been fixed. |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 0 |
| autoCallvote (preset setting) | |
| Explicit name | Auto-call vote |
| Description | When enabled, if a user tries to execute a command directly whereas he only has sufficient rights to call a vote for this command, then SPADS will automaticall call the vote for the user instead of trying to execute the command directly. |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| autoFixColors (preset setting) | |
| Explicit name | Auto-fix colors mode |
| Description | Specifies if and when player colors must be automatically fixed. When autoFixColors is set to "on", player colors are automatically fixed as soon as all following conditions are fulfilled: - there are at least minPlayers players in the battle lobby - the target number of players (1) is reached - teams can be made even (2) The "advanced" auto-fix colors mode works in the same way, except that it doesn't check if the target number of players is reached. It auto-fixes colors as soon as all other conditions are fulfilled. (1) The target number of players is computed from nbTeams, teamSize, and nbPlayerById (target number of players = nbTeams * teamSize * nbPlayerById) (2) i.e. current number of players in battle lobby is a multiple of nbTeams |
| Format / Allowed values | off: auto-fix colors disabled on: auto-fix colors enabled advanced: auto-fix colors enabled even if target number of players isn't reached |
| Default value | advanced |
| autoLoadMapPreset (preset setting) | |
| Explicit name | Auto-load map preset |
| Description | If enabled, SPADS will automatically load map presets when map is changed. If the corresponding map preset is not found, the default map preset named "_DEFAULT_.smf" is loaded if it exists. A map preset is a global preset defined in spads.conf which has the same name as a map, with .smf suffix. Map presets can be useful to automatically adjust allowed team sizes according to the map for instance. |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 0 |
| autoLock (preset setting) | |
| Explicit name | Auto-lock mode |
| Description | Specifies if and when battle lobby must be automatically locked/unlocked based on the number of players (this setting is totally independant from autoLockClients, which configures auto-locking based on total number of clients, i.e. players and spectators). When autoLock is set to "on", the battle lobby is automatically locked when target number of players (1) is reached. The "advanced" auto-lock mode works in the same way, except that if there are more players than the target number of players (2) and teams cannot be made even (3), then battle lobby is automatically unlocked until enough players join for teams to be made even again. (1) The target number of players is computed from nbTeams, teamSize, and nbPlayerById (target number of players = nbTeams * teamSize * nbPlayerById) (2) This can happen when a spectator unspecs after battle has been automatically locked for instance (3) i.e. current number of players in battle lobby isn't a multiple of nbTeams |
| Format / Allowed values | off: auto-lock based on number of players in battle lobby is disabled on: auto-lock battle lobby when there are enough players advanced: auto-lock battle lobby when there are enough players and teams can be made even |
| Default value | on |
| autoLockRunningBattle (preset setting) | |
| Explicit name | Auto-lock running battle |
| Description | When enabled, the battle lobby is automatically locked when a game is running (players won't be able to join the battle lobby when the game is in progress). |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 0 |
| autoSetVoteMode (preset setting) | |
| Explicit name | Default value of "Auto-set vote mode" preference |
| Description | This is the default value for the preference with same name (this value is used when a user hasn't set his preference). Refer to autoSetVoteMode for more information. |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| autoSpecExtraPlayers (preset setting) | |
| Explicit name | Auto-spec extra players |
| Description | When enabled, if the target number of players is reached in the battle lobby then SPADS will automatically force spectator mode for next players who join or try to unspec. The target number of players is computed from nbTeams, teamSize, and nbPlayerById (target number of players = nbTeams * teamSize * nbPlayerById) |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| autoStart (preset setting) | |
| Explicit name | Auto-start mode |
| Description | Specifies if and when game must be automatically started. When autoStart is set to "on", the game is automatically started as soon as all following conditions are fulfilled: - there are at least minPlayers players in the battle lobby - the target number of players (1) is reached - teams are even - no AI bot is enabled - all players are ready and synced, and no player is in-game The "advanced" auto-start mode works in the same way, except that it doesn't check if the target number of players is reached. It auto-starts as soon as all other conditions are fulfilled. (1) The target number of players is computed from nbTeams, teamSize, and nbPlayerById (target number of players = nbTeams * teamSize * nbPlayerById) |
| Format / Allowed values | off: auto-start disabled on: auto-start enabled advanced: auto-start enabled even if target number of players isn't reached |
| Default value | on |
| autoStop (preset setting) | |
| Explicit name | Auto-stop mode |
| Description | Specifies if and when game must be automatically stopped, with a configurable delay. |
| Format / Allowed values | noOpponent: game is auto-stopped when game is over or when there is only one team with connected alive player(s) (delay: 5 seconds) noOpponent(<delay>): game is auto-stopped when game is over or when there is only one team with connected alive player(s) (delay: <delay> seconds) onlySpec: game is auto-stopped when game is over or when only spectators are still connected (delay: 5 seconds) onlySpec(<delay>): game is auto-stopped when game is over or when only spectators are still connected (delay: <delay> seconds) gameOver: game is auto-stopped when game is over only (delay: 5 seconds) gameOver(<delay>): game is auto-stopped when game is over only (delay: <delay> seconds) off: game is not auto-stopped by AutoHost |
| Default value | gameOver |
| balanceMode (preset setting) | |
| Explicit name | Balance mode |
| Description | This is the balance mode used during both automatic (refer to autoBalance) and manual (refer to "!balance" command) team balancing operations. Four balance modes are currently available: The "random" balance mode simply balances players randomly. The "clan;random" balance mode ensures players of the same clans (refer to clanMode) are in the same teams. Other players are balanced randomly. The "skill" balance mode tries to balance teams according to player skills (refer to skillMode and rankMode), without respecting clans. The "clan;skill" balance mode tries to balance teams according to player skills (refer to skillMode and rankMode), respecting clans (refer to clanMode). |
| Format / Allowed values | random: balance players randomly, without respecting clans clan;random: balance players randomly, respecting clans skill: balance players according to their skill, without respecting clans clan;skill: balance players according to their skill, respecting clans |
| Default value | clan;skill |
| banList (preset setting) | |
| Explicit name | Ban list |
| Description | Current active ban list name, as defined in the banLists.conf file. |
| Format / Allowed values | Any string |
| Default value | empty |
| battlePreset (preset setting) | |
| Explicit name | Battle preset |
| Description | This preset setting contains the name of the current battle preset. This is a special preset setting: it cannot be changed by using !set command (the !bPreset command must be used instead). In spads.conf, it allows AutoHost administrators to both associate a default battle preset to the preset being defined, and select which battle presets users are allowed to switch to. |
| Format / Allowed values | Any battle preset name (defined in battlePresets.conf) |
| Default value | default |
| clanMode (preset setting) | |
| Explicit name | Clan mode |
| Description | This is the clan mode used during balancing operations if balanceMode is set to "clan" or "clan;skill". It determines how players are recognized as being in the same clan. If balanceMode is set to "clan;skill" and maximum unbalance is specified (see below), it also determines how much unbalance implied by clans is allowed. Unbalance is measured as the relative percent difference of the standard deviation of estimated team skills between optimal balance (without clan management) and requested balance. If <maxUnbalance> cannot be honored, then clans aren't taken into account for balancing. |
| Format / Allowed values | tag: players are considered as being in the same clan only if they have same tag in their names tag(<maxUnbalance>): same, except clans are only taken into account if <maxUnbalance> (integer) can be honored when balancing pref: players are considered as being in the same clan only if they have same clan value pref(<maxUnbalance>): same, except clans are only taken into account if <maxUnbalance> can be honored when balancing tag(<maxUnbalance1>);pref(<maxUnbalance2>): SPADS tries to balance by clan tag respecting <maxUnbalance1>. If it succeeds, then it also tries to handle clan values respecting <maxUnbalance2> (<maxUnbalance1> and/or <maxUnbalance2> can be omitted to remove balance constraint(s)) pref(<maxUnbalance1>);tag(<maxUnbalance2>): same, except it tries to respect clan values before clan tags |
| Default value | tag;pref(5) |
| colorSensitivity (preset setting) | |
| Explicit name | Color sensitivity |
| Description | When auto-fixing players colors, SPADS uses a formula to evaluate how much different 2 colors are. If the computed color difference is below the value of this setting, SPADS tries to change the offending colors. Using a very low value for this setting would allow players to use very similar colors. Using a very high value for this setting would change players colors almost every time, even if they seem really different. If set to 0, players colors are always forced using hard-coded colors (players can't choose their colors) If set to -1, players colors are always forced using an advanced color assignment algorithm, taking game mode and battle structure into account (players can't choose their colors) |
| Format / Allowed values | Positive integer: players colors are automatically changed if too similar 0: players colors are always forced using hard-coded values -1: players colors are always forced using an advanced color assignment algorithm |
| Default value | 55 (some colors may seem similar in battle lobby, but usually they are different enough in game) |
| commandsFile (preset setting) | |
| Explicit name | Commands file |
| Description | Name of the commands rights configuration file. This is a special preset setting: it cannot be changed by using !set command. |
| Format / Allowed values | Any readable file in etcDir |
| Default value | commands.conf |
| description (preset setting) | |
| Explicit name | Preset description |
| Description | Preset description that appears in "!list presets" output. This is a special preset setting: it cannot be changed by using !set command. |
| Format / Allowed values | Any String |
| Default value | Default SPADS settings |
| endGameAwards (preset setting) | |
| Explicit name | End game awards |
| Description | Specifies if award messages based on team statistics must be printed after each game |
| Format / Allowed values | 0: award messages disabled 1: award messages enabled except for 1v1 2: award messages enabled for all games |
| Default value | 1 |
| endGameCommand (preset setting) | |
| Explicit name | End game command |
| Description | Specifies a shell command to execute each time a game ends. This is a special preset setting: it cannot be changed by using !set command and it is not shown in "!list settings". Following placeholders can be used as command parameters: %startTimestamp: server start timestamp (example: '1339938200') %endTimestamp: server stop timestamp (example: '1339939006') %duration: server running time in seconds (example: '806') %startPlayingTimestamp: game start timestamp (example: '1339938300') %endPlayingTimestamp: game over timestamp (example: '1339939000') %gameDuration: game duration in seconds (example: '700') %engineVersion: engine major version (example: '89') %mod: mod name (example: 'Balanced Annihilation V7.68') %map: map name (example: 'DeltaSiegeDry') %type: game type ('Solo','Duel','FFA','Team','TeamFFA') %structure: structure of the game (examples: '1', '1v1','8-way','8v8','3v3v3') %nbBots: number of AI bots (example: '0') %ahName: autohost name (example: 'Spads4') %ahAccountId: autohost account ID (example: '77888') %ahPassword: autohost lobby password (example: 'abcd') %ahPassHash: autohost hashed lobby password, as sent to lobby server on login (example: 'ahdPrHyuJJfsPj+bZE+nrw==') %demoFile: absolute path to the game replay file (example: '/home/spring/demos/20120617_143502_DeltaSiegeDry_88.sdf') %gameId: game hash uniquely identifying the game, as generated by Spring on startup (example: 'c7c6dc4f79cd4f3cfb8fc1a397174d8b') %result: end game result ('gameOver','undecided') %cheating: indicates if cheats have been enabled during game ('0': cheats disabled, '1': cheats enabled) |
| Format / Allowed values | <null> (functionality disabled) Valid shell command |
| Default value | <null> |
| endGameCommandEnv (preset setting) | |
| Explicit name | End game command environment variables |
| Description | Specifies the environment variables to define before launching the end game command (refer to endGameCommand) This is a special preset setting: it cannot be changed by using !set command and it is not shown in "!list settings". Following placeholders can be used in the environment variables values: %startTimestamp: server start timestamp (example: '1339938200') %endTimestamp: server stop timestamp (example: '1339939006') %duration: server running time in seconds (example: '806') %startPlayingTimestamp: game start timestamp (example: '1339938300') %endPlayingTimestamp: game over timestamp (example: '1339939000') %gameDuration: game duration in seconds (example: '700') %engineVersion: engine major version (example: '89') %mod: mod name (example: 'Balanced Annihilation V7.68') %map: map name (example: 'DeltaSiegeDry') %type: game type ('Solo','Duel','FFA','Team','TeamFFA') %structure: structure of the game (examples: '1', '1v1','8-way','8v8','3v3v3') %nbBots: number of AI bots (example: '0') %ahName: autohost name (example: 'Spads4') %ahAccountId: autohost account ID (example: '77888') %ahPassword: autohost lobby password (example: 'abcd') %ahPassHash: autohost hashed lobby password, as sent to lobby server on login (example: 'ahdPrHyuJJfsPj+bZE+nrw==') %demoFile: absolute path to the game replay file (example: '/home/spring/demos/20120617_143502_DeltaSiegeDry_88.sdf') %gameId: game hash uniquely identifying the game, as generated by Spring on startup (example: 'c7c6dc4f79cd4f3cfb8fc1a397174d8b') %result: end game result ('gameOver','undecided') %cheating: indicates if cheats have been enabled during game ('0': cheats disabled, '1': cheats enabled) |
| Format / Allowed values | <null> (functionality disabled) Variables assignments, separated by ';' |
| Default value | <null> |
| endGameCommandMsg (preset setting) | |
| Explicit name | End game command messages |
| Description | Specifies the messages sent to battle lobby when the end-game command ends (refer to endGameCommand). Lines are separated by "|", and optionally prefixed by "(<exitCodeRange>)" (in this case they are only printed if the end-game command exit code matches). This is a special preset setting: it cannot be changed by using !set command and it is not shown in "!list settings". Following placeholders can be used in the messages: %engineVersion: engine major version (example: '89') %mod: mod name, URL encoded (example: 'Balanced%20Annihilation%20V7.68') %map: map name, URL encoded (example: 'Comet%20Catcher%20Redux') %type: game type ('Solo','Duel','FFA','Team','TeamFFA') %ahName: autohost name (example: 'Spads4') %ahAccountId: autohost account ID (example: '77888') %demoName: game replay file name, without path and URL encoded (example: '20120617_143502_Comet%20Catcher%20Redux_89.sdf') %gameId: game hash uniquely identifying the game, as generated by Spring on startup (example: 'c7c6dc4f79cd4f3cfb8fc1a397174d8b') %result: end game result ('gameOver','undecided') |
| Format / Allowed values | <null> (functionality disabled) [(<exitCodeRange1>)]<message1>[|[(<exitCodeRange2>)]<message2>[|...]] |
| Default value | <null> |
| extraBox (preset setting) | |
| Explicit name | Extra box |
| Description | Specifies the number of extra map boxes required by current game, in addition to the normal start boxes. Extra boxes are special boxes required by some specific game modes such as King Of The Hill. Contrary to normal start boxes, extra boxes are not used to specify a team start location. Instead, they are used to give special meanings to specific map locations. SPADS uses this setting to manage totally independent groups of saved map boxes (one for each value of the extraBox setting). |
| Format / Allowed values | Integer |
| Default value | 0 |
| forwardLobbyToGame (preset setting) | |
| Explicit name | Forward lobby chat to game |
| Description | If enabled, chat messages in battle lobby are automatically forwarded to game. If disabled, players have to use the !say command to forward messages to game. Note: In-game messages are always forwarded to battle lobby (except team messages, spectator messages and whispered messages) |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| freeSettings (preset setting) | |
| Explicit name | Free settings |
| Description | Contains the list of preset settings (and optionnaly their values) that can be changed directly by players without having to call a vote, provided the players have sufficient rights to call a vote for the !set command. In other words, if a player has sufficient rights to call a vote to change the setting, then he can change it directly. |
| Format / Allowed values | List of preset settings, separated by ";" Optional value restrictions can be added for each setting, inside parentheses and separated by "," (ranges can be used for numbers) |
| Default value | autoLock;teamSize(1-6);balanceMode |
| ghostMapLink (preset setting) | |
| Explicit name | Ghost map link |
| Description | Defines the map link which is used to build welcome messages (refer to welcomeMsg and welcomeMsgInGame) and !mapLink command answer, when current map is a ghost map (refer to mapLink for local map case). %m is replaced by the map name (with spaces replaced by "%20" so that it can be used in url) %h is replaced by the unsigned map hash This is a special preset setting: it cannot be changed by using !set command. |
| Format / Allowed values | <null> (no map link, !mapLink command disabled) Any string |
| Default value | https://springfiles.springrts.com/index.html?type=1&filter=%m&category=map |
| handleSuggestions (preset setting) | |
| Explicit name | Default value of "Handle suggestions" preference |
| Description | This is the default value for the preference with same name (this value is used when a user hasn't set his preference). Refer to handleSuggestions for more information. |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 0 |
| hideMapPresets (preset setting) | |
| Explicit name | Hide map presets |
| Description | If enabled, map presets will not be shown in "!list presets" output. A map preset is a global preset defined in spads.conf which has the same name as a map, with .smf suffix. |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 0 |
| hostingPreset (preset setting) | |
| Explicit name | Hosting preset |
| Description | This preset setting contains the name of the current hosting preset. This is a special preset setting: it cannot be changed by using !set command (the !hPreset command must be used instead). In spads.conf, it allows AutoHost administrators to both associate a default hosting preset to the preset being defined, and select which hosting presets users are allowed to switch to. |
| Format / Allowed values | Any hosting preset name (defined in hostingPresets.conf) |
| Default value | default |
| idShareMode (preset setting) | |
| Explicit name | ID share mode |
| Description | Specifies how SPADS chooses which players are sharing IDs. |
| Format / Allowed values | all: all players of each team are sharing ID (SPADS counts the number of players in each team to know if teams are even) auto: nbPlayerById and balanceMode are used to determine shared IDs (SPADS counts the number of IDs in each team to know if teams are even) manual: shareId (coop group) is used to determine shared IDs (SPADS counts the number of players in each team to know if teams are even) clan: same as "manual", except that the clan tag is used as default shareId (coop group) value for clan players off: ID sharing is disabled (SPADS counts the number of players in each team to know if teams are even) |
| Default value | auto |
| ircColors (preset setting) | |
| Explicit name | Default value of "Use IRC colors" preference |
| Description | This is the default value for the preference with same name (this value is used when a user hasn't set his preference). Refer to ircColors for more information. |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 0 |
| localBots (preset setting) | |
| Explicit name | Local bots |
| Description | This is the list of predefined local bots. Automatically added bots are taken from this list (see autoAddBotNb). |
| Format / Allowed values | [<name> <side>[#<rgbColor>] <ai>[;<name2> <side2>[#<rgbColor2>] <ai2>[...]]] where <name> is the name of the bot (string, example: "joe") <side> is the faction of the bot (can be the faction number or the faction name) <rgbColor> is the default color of the bot in hexadecimal RGB format (example: "FF0000" for red) <ai> is the exact name of the AI used by the bot (string, example: "E323AI") |
| Default value | joe 0 E323AI;jim core#FF0000 KAIK |
| map (preset setting) | |
| Explicit name | Map name |
| Description | Current map name (default is first map of current map list if not set) This special preset setting can be changed by using the classic "!set map" command, but also the "!map" alias. |
| Format / Allowed values | <null> Any map of current map list (defined in mapLists.conf). |
| Default value | <null> |
| mapLink (preset setting) | |
| Explicit name | Map link |
| Description | Defines the map link which is used to build welcome messages (refer to welcomeMsg and welcomeMsgInGame) and !mapLink command answer, when current map is a local map (refer to ghostMapLink for ghost map case). %m is replaced by the map name (with spaces replaced by "%20" so that it can be used in url) %M is replaced by the map archive (with spaces replaced by "%20" so that it can be used in url) %h is replaced by the unsigned map hash This is a special preset setting: it cannot be changed by using !set command. |
| Format / Allowed values | <null> (no map link, !mapLink command disabled) Any string |
| Default value | https://springfiles.springrts.com/index.html?type=1&filter=%m&category=map |
| mapList (preset setting) | |
| Explicit name | Map list |
| Description | Current map list name. Only the maps included in this map list will be available for "!list maps", !set map", and "!map" commands (and automatic map rotation). |
| Format / Allowed values | Any map list name (defined in mapLists.conf) |
| Default value | all |
| maxBots (preset setting) | |
| Explicit name | Maximum number of AI bots |
| Description | When this number of AI bots are in the battle lobby, SPADS will auto-kick any additional AI bot added. A value of 0 will prevent anyone from adding an AI bot. |
| Format / Allowed values | Integer |
| Default value | 8 |
| maxLocalBots (preset setting) | |
| Explicit name | Maximum number of local AI bots |
| Description | When this number of local AI bots (bots hosted at server side) are in the battle lobby, SPADS will auto-kick any additional local AI bot added. A value of 0 will prevent anyone from adding a local AI bot. |
| Format / Allowed values | Integer |
| Default value | 8 |
| maxRemoteBots (preset setting) | |
| Explicit name | Maximum number of remote AI bots |
| Description | When this number of remote AI bots (bots hosted by players) are in the battle lobby, SPADS will auto-kick any additional remote AI bot added. A value of 0 will prevent anyone from adding a remote AI bot. |
| Format / Allowed values | Integer |
| Default value | 8 |
| maxSpecs (preset setting) | |
| Explicit name | Maximum number of spectators |
| Description | When this number of spectators are in the battle lobby, SPADS will auto-kick any additional player who joins as spectator. A value of 0 will prevent anyone from spectating. |
| Format / Allowed values | <null> (no spectator number limit) Integer |
| Default value | <null> |
| midGameSpecLevel (preset setting) | |
| Explicit name | Minimum access level for midgame join as spectator |
| Description | When a user has an AutoHost access level superior or equal to this value, he is allowed to join a game in progress as spectator directly (without using !joinAs command) even if he wasn't in the battleroom when the game started. |
| Format / Allowed values | Integer |
| Default value | 0 |
| minPlayers (preset setting) | |
| Explicit name | Minimum number of players |
| Description | This is the minimum number of players to start a game without using "!forceStart" command. Battle auto-management isn't performed when there is less players (refer to autoStart, autoBalance and autoFixColors). |
| Format / Allowed values | Integer |
| Default value | 2 |
| minRingDelay (preset setting) | |
| Explicit name | Default value of "Minimum ring delay" preference |
| Description | This is the default value for the preference with same name (this value is used when a user hasn't set his preference). Refer to minRingDelay for more information. |
| Format / Allowed values | Integer |
| Default value | 20 |
| minTeamSize (preset setting) | |
| Explicit name | Minimum team size |
| Description | When auto-balancing, normaly nbTeams has higher priority than teamSize, which means that if there aren't enough players to reach target battle structure, SPADS will try to put at least one player in each team before adding players to existing teams. minTeamSize makes it possible to alter this behaviour: it specifies the minimum team size before starting to fill another team when auto-balancing. This is only useful for TeamFFA, when there aren't enough players to fulfill target battle structure: it makes SPADS decrease the number of teams so that there are at least this number of people in each team. If minTeamSize is set to 0, it simply makes teamSize have higher priority than nbTeams (it acts as if minTeamSize had same value as teamSize). |
| Format / Allowed values | Integer |
| Default value | 1 |
| nbPlayerById (preset setting) | |
| Explicit name | Number of player by ID |
| Description | Spring engine supports having multiple players controling the same units. The "nbPlayerById" preset setting specifies the target number of players controling the same units (i.e., sharing the same ID). This is one of the three preset settings used by SPADS to determine the target battle structure (for battle auto-management in particular): - nbTeams (number of teams in the game) - teamSize (number of ID by team) - nbPlayerById (number of player by ID) |
| Format / Allowed values | Non-null integer |
| Default value | 1 |
| nbTeams (preset setting) | |
| Explicit name | Number of teams |
| Description | Target number of teams This is one of the three preset settings used by SPADS to determine the target battle structure (for battle auto-management in particular): - nbTeams (number of teams in the game) - teamSize (number of ID by team) - nbPlayerById (number of player by ID) If nbTeams is set to 1, then SPADS will put all human players in team 1, and all bots in team 2. This special mode is usefull for "humans vs bots" type of games (chickens...) |
| Format / Allowed values | Non-null integer |
| Default value | 2 |
| noSpecChat (preset setting) | |
| Explicit name | No spectator chat |
| Description | If enabled, spectators can only chat with other spectators in game |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 0 |
| noSpecDraw (preset setting) | |
| Explicit name | No spectator draw |
| Description | If enabled, drawing ability is disabled for spectators |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 0 |
| preset (preset setting) | |
| Explicit name | Global preset |
| Description | This preset setting contains the name of the current global preset. This is a special preset setting: it cannot be changed by using !set command (the !preset or !forcePreset commands must be used instead). The only purpose of this setting is to allow AutoHost administrators to list the other presets users are allowed to switch to. In spads.conf, the first value of this setting (i.e., the default value) must always be the name of the preset being defined, and the alternate values (separated by '|' character) are the other allowed presets users are allowed to switch to from current preset. |
| Format / Allowed values | Any global preset name (defined in spads.conf) |
| Default value | default |
| rankMode (preset setting) | |
| Explicit name | Default value of "Rank mode" preference |
| Description | This is the default value for the preference with same name (this value is used when the user's rankMode hasn't been set with !chrank command). Refer to rankMode for more information. |
| Format / Allowed values | account ip 0 1 2 3 4 5 6 |
| Default value | account |
| rotationDelay (preset setting) | |
| Explicit name | Rotation delay |
| Description | SPADS automatic rotation system can occur at the end of each game and/or when the battle is empty (refer to rotationEndGame and rotationEmpty). The "rotationDelay" preset setting specifies the minimum delay in seconds between two automatic rotations: it is both the minimum game duration for automatic end-game rotation, and the delay between two automatic rotations when battle is empty. |
| Format / Allowed values | Integer |
| Default value | 300 |
| rotationEmpty (preset setting) | |
| Explicit name | Empty battle rotation mode |
| Description | When the battle lobby is empty, SPADS can automatically rotate map or preset. The "rotationEmpty" preset setting specifies if empty-battle rotation is enabled, and what mode is enabled. |
| Format / Allowed values | off: empty-battle automatic rotation is disabled random: empty-battle automatic rotation is enabled (maps or presets are chosen randomly) order: empty-battle automatic rotation is enabled (maps or presets are rotated in order) |
| Default value | random |
| rotationEndGame (preset setting) | |
| Explicit name | End-game rotation mode |
| Description | When a game ends, SPADS can automatically rotate map or preset. The "rotationEndgame" preset setting specifies if end-game rotation is enabled, and what mode is enabled. |
| Format / Allowed values | off: end-game automatic rotation is disabled random: end-game automatic rotation is enabled (maps or presets are chosen randomly) order: end-game automatic rotation is enabled (maps or presets are rotated in order) |
| Default value | off |
| rotationManual (preset setting) | |
| Explicit name | Manual rotation mode |
| Description | When using !nextMap or !nextPreset commands, SPADS rotates map or preset. The "rotationManual" preset setting specifies which rotation mode is used in this case. |
| Format / Allowed values | random: maps or presets are chosen randomly order: maps or presets are rotated in order |
| Default value | random |
| rotationType (preset setting) | |
| Explicit name | Rotation type |
| Description | SPADS automatic rotation system can occur at the end of each game and/or when the battle is empty (refer to rotationEndGame and rotationEmpty). The "rotationType" preset setting specifies whether map rotation or preset rotation is selected. When map rotation is selected, a new map is chosen automatically in current map list. A subset of current map list can be specified for map rotation (refer to syntax below) When preset rotation is selected, a new preset available from current preset is chosen automatically (refer to preset) |
| Format / Allowed values | map: map rotation is selected (any map of current map list can be chosen as next map) preset: preset rotation is selected (any preset available form current preset can be chosen as next preset) map;<subMapList>: map rotation with sub map list filter is selected (any map belonging to both current map list and <subMapList> can be chosen as next map) |
| Default value | map |
| shareId (preset setting) | |
| Explicit name | Default value of "Share ID (coop group)" preference |
| Description | This is the default value for the preference with same name (this value is used when a user hasn't set his preference). Refer to shareId for more information. |
| Format / Allowed values | <null> Any string |
| Default value | <null> |
| skillMode (preset setting) | |
| Explicit name | Default value of "Skill mode" preference |
| Description | This is the default value for the preference with same name (this value is used when the user's skillMode hasn't been set with !chskill command). Refer to skillMode for more information. |
| Format / Allowed values | rank TrueSkill |
| Default value | rank |
| speedControl (preset setting) | |
| Explicit name | Auto adjust game speed |
| Description | Specifies how the game speed must be auto-adjusted according to current players CPU usages. |
| Format / Allowed values | 1: use average CPU usage to auto-adjust game speed (this setting will drop players having slow CPUs if they are slowing the game) 2: use maximum CPU usage to auto-adjust game speed (this setting will slow the game to allow players having slow CPUs to catch up) |
| Default value | 2 |
| spoofProtection (preset setting) | |
| Explicit name | Default value of "Spoof protection" preference |
| Description | This is the default value for the preference with same name (this value is used when a user hasn't set his preference). Refer to spoofProtection for more information. |
| Format / Allowed values | on off warn |
| Default value | warn |
| teamSize (preset setting) | |
| Explicit name | Team size |
| Description | Target size of each team (number of ID by team). This is one of the three preset settings used by SPADS to determine the target battle structure (for battle auto-management in particular): - nbTeams (number of teams in the game) - teamSize (number of ID by team) - nbPlayerById (number of player by ID) |
| Format / Allowed values | Non-null integer |
| Default value | 6 |
| unlockSpecDelay (preset setting) | |
| Explicit name | Unlock-for-spectator delay |
| Description | The !unlockSpec command allows players to unlock temporarily a battle so that they can join as spectator: the battle is unlocked and re-locked automatically as soon as they join it. The "unlockSpecDelay" preset setting specifies both the maximum delay during which battle is unlocked to allow the spectator to join (if he didn't join during this time, the battle is re-locked anyway to prevent other players to join and think they can play), and the minimum delay before the same user can execute the !unlockSpec command another time. |
| Format / Allowed values | <unlockTime>;<delayForRetry> where <unlockTime> is the maximum delay in seconds during which battle is unlocked to allow the spectator to join <delayForRetry> is the minimum delay in seconds before the same user can execute the !unlockSpec command another time |
| Default value | 2;30 |
| voteMode (preset setting) | |
| Explicit name | Default value of "Vote mode" preference |
| Description | This is the default value for the preference with same name (this value is used when a user hasn't set his preference). Refer to voteMode for more information. |
| Format / Allowed values | normal: normal vote mode away: away vote mode |
| Default value | normal |
| votePvMsgDelay (preset setting) | |
| Explicit name | Default value of "Vote auto-private message delay" preference |
| Description | This is the default value for the preference with same name (this value is used when a user hasn't set his preference). Refer to votePvMsgDelay for more information. |
| Format / Allowed values | Integer |
| Default value | 0 |
| voteRingDelay (preset setting) | |
| Explicit name | Default value of "Vote auto-ring delay" preference |
| Description | This is the default value for the preference with same name (this value is used when a user hasn't set his preference). Refer to voteRingDelay for more information. |
| Format / Allowed values | Integer |
| Default value | 0 |
| welcomeMsg (preset setting) | |
| Explicit name | Welcome message |
| Description | Message sent to battle lobby when a player joins the battle (lines are separated by character '|'). Lines prefixed with '!' are only sent to the user joining the battle (only supported by uberserver). %u is replaced by the user joining the battle %l is replaced by the user access level %d is replaced by the description of the user access level %m is replaced by the map name (with spaces replaced by "%20" so that it can be used in url) %n is replaced by the lobby name of the AutoHost %v is replaced by SPADS main version number %h is replaced by the unsigned map hash %a is replaced by the map link as specified by mapLink or ghostMapLink %t is replaced by the time elapsed since last game start %p is replaced by the currently active global preset %P is replaced by the description of the currently active global preset This is a special preset setting: it cannot be changed by using !set command. |
| Format / Allowed values | <null> (no welcome message) Any string |
| Default value | Hi %u (%d), welcome to %n (SPADS %v, automated host).|!For help, say "!help". Map link: %a |
| welcomeMsgInGame (preset setting) | |
| Explicit name | Welcome message when game is running |
| Description | Message sent to battle lobby when a player joins the battle while game is running (lines are separated by character '|'). Lines prefixed with '!' are only sent to the user joining the battle (only supported by uberserver). %u is replaced by the user joining the battle %l is replaced by the user access level %d is replaced by the description of the user access level %m is replaced by the map name (with spaces replaced by "%20" so that it can be used in url) %n is replaced by the lobby name of the AutoHost %v is replaced by SPADS main version number %h is replaced by the unsigned map hash %a is replaced by the map link as specified by mapLink or ghostMapLink %t is replaced by the duration of current game in progress %p is replaced by the currently active global preset %P is replaced by the description of the currently active global preset This is a special preset setting: it cannot be changed by using !set command. |
| Format / Allowed values | <null> (no welcome message) Any string |
| Default value | Hi %u (%d), welcome to %n (SPADS %v, automated host).|!A game is in progress since %t.|!Say "!status" for more information, and "!notify" to be notified when this game ends. |