| alertDelay (global setting) | |
| Explicit name | Alert delay |
| Description | Delay in hours before re-sending alerts to a user |
| Format / Allowed values | Integer |
| Default value | 6 |
| alertDuration (global setting) | |
| Explicit name | Alert duration |
| Description | After this delay (in hours), alerts are automatically discared. This delay shouldn't be too low because an AutoHost admin could miss alerts if he doesn't connect to lobby server very often. |
| Format / Allowed values | Integer |
| Default value | 72 |
| alertLevel (global setting) | |
| Explicit name | Alert level |
| Description | Minimum AutoHost access level required to receive AutoHost alerts (do not set this too low or you will spam everyone !) |
| Format / Allowed values | Integer |
| Default value | 130 |
| allowSettingsShortcut (global setting) | |
| Explicit name | Allow settings shortcut |
| Description | If enabled, SPADS will allow clients to use following shortuct commands: Instead of "!list <dataType>", it is possible to type directly "!<dataType>". Instead of "!set <settingName> <value>", it is possible to type directly "!<settingName> <value>" (same for "hSet", "bSet" ...). Instead of "!help set <settingName>", it is possible to type directly "!help <settingName>" (same for "hSet", "bSet" ...). |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| autoHostInterfaceLogLevel (global setting) | |
| Explicit name | AutoHost interface log level |
| Description | Log level of the AutoHost interface module |
| Format / Allowed values | 0: critical 1: errors 2: warnings 3: notices 4: information 5: debug (all messages sent and received on the interface are logged!) |
| Default value | 4 |
| autoHostPort (global setting) | |
| Explicit name | AutoHost private port |
| Description | UDP port used for local communication between AutoHost and Spring server |
| Format / Allowed values | Any valid port number |
| Default value | 8454 |
| autoLearnMaps (global setting) | |
| Explicit name | Automatic map learning |
| Description | Specifies if SPADS must learn automatically all the maps hosted by the other hosts, so that it can host them in ghost-map mode later (without having them locally on the server) |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 0 |
| autoLoadPlugins (global setting) | |
| Explicit name | Auto-loaded plugins |
| Description | Contains the names of the SPADS plugins that will be automatically loaded on start, separated by ';' |
| Format / Allowed values | <null>: no plugin loaded autmatically <pluginName>[;<pluginName2>[...]]: plugins <pluginName>, <pluginName2>[...] will be automatically loaded on start |
| Default value | <null> |
| autoLockClients (global setting) | |
| Explicit name | Number of clients for auto-lock |
| Description | When this number of clients (players and spectators) is in the battle lobby, SPADS auto-locks the battle. This is useful when you know your network connection cannot support more than x clients, should they be players or spectators. This is different from maxPlayers, which configures the hosting room capacity regarding number of players only. This is also different from autoLock, which configures auto-locking based on number of players only. When set to 0, it disables the auto-lock on client count functionality. |
| Format / Allowed values | Integer |
| Default value | 64 |
| autoManagedSpringDir (global setting) | |
| Explicit name | Auto-managed Spring directory |
| Description | Location of the Spring binary files downloaded automatically by SPADS when Spring version auto-management is enabled (cf autoManagedSpringVersion). This directory path can be an absolute path or a path relative to varDir directory. |
| Format / Allowed values | Any writable directory |
| Default value | spring |
| autoManagedSpringVersion (global setting) | |
| Explicit name | Auto-managed Spring version |
| Description | If this setting is defined, then engine version auto-management is enabled: SPADS automatically downloads and uses engine binaries matching the version/release specified (auto-downloaded binaries are stored in the directory specified by autoManagedSpringDir). The desired Spring version can be specified as a version number directly (for example: "103.0.1-1272-g170516f", "103.0" ...), or as a release name ("stable", "testing" or "unstable"). When a version number is used, SPADS will stick to this version until the setting is changed manually. When a release name is used, SPADS will stay up to date with the corresponding official Spring release by automatically downloading and using new Spring binary files when needed (the "stable" release is the current recommended Spring version, the "testing" release is the next Spring release candidate, and the "unstable" release is the latest develop version). A check delay and an auto-restart mode can optionnaly be provided to alter default behaviour (see below). When Spring version auto-management is enabled, springServerType must be defined to specify which type of Spring server must be used (dedicated or headless). The auto-managed Spring version setting and the custom Spring installation settings are mutually exclusive: either Spring version auto-management is enabled and the custom Spring installation settings (unitsyncDir and springServer) must not be defined, or Spring version auto-management is disabled and the custom Spring installation settings (unitsyncDir and springServer) must be defined. Engine version auto-management can also be enabled for any Spring-based engine whose releases are stored on GitHub. In this case a GitHub-specific prefix must be added to the value described above with following format: [GITHUB]{owner=<repositoryOwner>,name=<repositoryName>,tag=<releaseTagTemplate>,asset=<assetRegularExpresion>} <repositoryOwner> is the name of the GitHub user/organization who owns the repository <repositoryName> is the name of the GitHub repository containing the engine releases <releaseTagTemplate> is the template of the tags used for the releases. It must contain the "<version>" placeholder indicating where the engine version is located in the tag name, and it can contain the "<branch>" placeholder indicating where the Git branch is located in the tag name (for multi-branch tag templates). Multiple tag templates can be provided by separating them using character "|". <assetRegularExpression> is the regular expression used to select the release asset to download and install. This regular expression can contain the "<os>", "<bitness>" and "<arch>" placeholders: "<os>" will be automatically replaced by the current operating system ("linux" or "windows"), "<bitness>" will be replaced by the system bitness ("64" or "32"), and "<arch>" will be replaced by the system architecture ("amd64" or "i386"). Multiple asset regular expressions can be provided by separating them using character "|". As for official Spring engine, it is possible to select a specific engine version number or an engine release: the "stable" release is the release tagged "Latest" on GitHub, the "testing" release is the most recent release tagged "Pre-release" or "Latest" on GitHub, and the "unstable" release is simply the most recent release available on GitHub (ignoring release tags). As a special case of engine auto-management from GitHub, it is also possible to use the "[RECOIL]" prefix instead of "[GITHUB]{owner=...}". The "[RECOIL]" prefix is simply a shortcut for "[GITHUB]{owner=beyond-all-reason,name=spring,tag=recoil{<branch>}<version>|spring_bar_{<branch>}<version>|<version>,asset=recoil_.+_<arch>-<os>\.7z|.+_<os>-<bitness>-minimal-portable\.7z}". When using Recoil engine, two additional rolling releases are available for engine auto-management: "bar" and "barTesting", which correspond to the versions used by official "Beyond All Reason" launcher. |
| Format / Allowed values | <null>: Spring version auto-management is disabled (the custom Spring installation specified by unitsyncDir and springServer is used instead) <springVersionNumber>: SPADS auto-downloads Spring binaries for this specific version if needed, and sticks to this version <springRelease>: SPADS stays up to date with the selected Spring release ("stable", "testing", "unstable") <springRelease>;<checkDelay>;<autoRestartMode>: same, with customization of check delay and auto-restart mode <checkDelay> is the delay in minutes between Spring version checks for selected release (integer). Default is "60" for "stable" Spring release, "30" for "testing" and "15" for "unstable" <autoRestartMode> specifies if and when SPADS must auto-restart after Spring release updates, allowed values: "off", "whenEmpty", "whenOnlySpec", "on". Default is "whenEmpty" [GITHUB]{owner=<repositoryOwner>,name=<repositoryName>,tag=<releaseTagTemplate>,asset=<assetRegularExpresion>}<engineVersionNumberOrRelease> [RECOIL]<engineVersionNumberOrRelease> |
| Default value | %autoManagedSpringVersion% (set during installation) |
| autoReloadArchivesMinDelay (global setting) | |
| Explicit name | Minimum delay before auto-reloading Spring archives |
| Description | SPADS can auto-detect changes in Spring archives, and auto-reload them if needed. If the autoReloadArchivesMinDelay is set to 0, then this feature is disabled, else it is enabled. When this feature is enabled, the autoReloadArchivesMinDelay contains the minimum delay in seconds to wait since the last change in Spring archives before reloading them automatically (this is useful to avoid reloading incomplete archives that are still being uploaded for instance). |
| Format / Allowed values | Integer |
| Default value | 30 |
| autoRestartForUpdate (global setting) | |
| Explicit name | Auto-restart for update |
| Description | Specifies if SPADS must check regularly if its packages have been updated, and how it must restart on update. |
| Format / Allowed values | off: SPADS doesn't check if its packages have been updated, and thus never auto-restarts for update whenEmpty: SPADS auto-restarts for update only when no game is running and battle is empty whenOnlySpec: SPADS auto-restarts for update only when no game is running and battle is empty or only contains spectators on: SPADS auto-restarts for update when no game is running |
| Default value | whenEmpty |
| autoSaveBoxes (global setting) | |
| Explicit name | Auto-save start boxes |
| Description | If enabled, SPADS will automatically save the start boxes when a game is launched. |
| Format / Allowed values | 0: disabled 1: enabled 2: enabled only if there is no start box saved for this map yet |
| Default value | 1 |
| autoUpdateDelay (global setting) | |
| Explicit name | Auto-update delay |
| Description | Delay in minutes between checks of SPADS repository for update. A value of 0 disables auto-update when SPADS is running, but SPADS keeps auto-updating at start if the <autoUpdateRelease> parameter is defined. |
| Format / Allowed values | Integer |
| Default value | 60 |
| autoUpdateRelease (global setting) | |
| Explicit name | Auto-update release |
| Description | Name of the SPADS release to auto-update to. |
| Format / Allowed values | <null>: auto-update is disabled stable: auto-update to "stable" release (latest official release) testing: auto-update to "testing" release (public testing release) unstable: auto-update to "unstable" release (release in development) contrib: auto-update to "contrib" release (public testing release + unchecked external patches) |
| Default value | %release% (set during installation) |
| awayVoteDelay (global setting) | |
| Explicit name | Away vote delay |
| Description | Configures the delay to wait before triggering automatic blank votes for players who are in away vote mode (see voteMode). The delay can be expressed as a number of seconds or a percentage of the vote time (see voteTime). This global setting can also be overridden individually for each command in the commands rights configuration file (see commandsFile). The command-specific setting value must be declared at the end of the corresponding command declaration line, in parentheses. If multiple settings are overridden this way for a command, they must be separated by a comma. For example, to use specific values of "voteTime" and "awayVoteDelay" for the "stop" command, the command declaration line could be: "[stop](voteTime:60,awayVoteDelay:50%)". |
| Format / Allowed values | <null>: the away vote mode is disabled Integer: number of seconds to wait before triggering automatic blank votes <percent>%: percentage of total vote time to wait before triggering automatic blank votes |
| Default value | 20 |
| bansData (global setting) | |
| Explicit name | Bans data mode |
| Description | Data storage and sharing mode for players bans. When set to "private", the data file is stored in the instanceDir directory and is private to each SPADS instance. When set to "shared", the data file is stored in the varDir directory by default and is shared between all SPADS instances that use the same configuration. The default file name for the data file is "bans.dat". When using shared mode, an alternate file name/location can be provided in parentheses after the "shared" keyword to use a specific non-default name/location for the data file. |
| Format / Allowed values | private: bans are private to each SPADS instance and stored in the "bans.dat" file located in the instanceDir directory shared: bans are shared between all SPADS instances that use the same configuration and stored in the "bans.dat" file located in the varDir directory shared(<fileLocation>): bans are shared between all SPADS instances that use the same configuration and stored in the <fileLocation> file (if <fileLocation> is a relative path, it is relative to the varDir directory) |
| Default value | shared |
| botsRank (global setting) | |
| Explicit name | Rank for bots |
| Description | This setting defines the rank attibuted to AI bots when auto-balancing the battle. |
| Format / Allowed values | 0: Newbie 1: Beginner 2: Average 3: Above average 4: Experienced 5: Highly experienced 6: Veteran |
| Default value | 3 |
| broadcastChannels (global setting) | |
| Explicit name | List of broadcast channels |
| Description | Contains the list of lobby channels in which basic battle status messages are broadcasted. |
| Format / Allowed values | <null> (functionality disabled) <channel1>[ <password1>][;<channel2>[ <password2>][;...]] |
| Default value | <null> |
| cmdFloodAutoIgnore (global setting) | |
| Explicit name | Command flood auto-ignore thresholds |
| Description | Specifies the record period, the maximum number of commands someone can send to the AutoHost during this period before being auto-ignored, and the duration of this automatic ignore for command flood protection |
| Format / Allowed values | <nbCmd>;<delay>;<ignoreDuration> where <nbCmd> is the maximum number of commands someone can send to the AutoHost before ignore (integer) <delay> is the record period in seconds (integer) <ignoreDuration> is the duration in minutes of the automatic ignore for command flood (integer) |
| Default value | 4;4;2 |
| dataDumpDelay (global setting) | |
| Explicit name | Data dump delay |
| Description | User preferences and map hashes are stored periodicly into preferences.dat and mapHashes.dat files. This setting defines the delay in minutes between such dumps. If set to 0, the functionality is disabled (dynamic data are then dumped only when SPADS exits normally) |
| Format / Allowed values | Integer |
| Default value | 60 |
| defaultPreset (global setting) | |
| Explicit name | Default preset |
| Description | It is the default preset name. Presets are defined as sections of spads.conf file. The default preset must be complete (i.e. it must define all preset settings) |
| Format / Allowed values | Any complete preset defined in spads.conf |
| Default value | default |
| etcDir (global setting) | |
| Explicit name | SPADS configuration directory |
| Description | Location of SPADS configuration files. This directory path can be an absolute path or a path relative to SPADS installation directory. |
| Format / Allowed values | Any readable directory |
| Default value | %etcDir% (set during installation, examples: "etc", "/var/home/spring/spads/etc", "C:\Program files\Spads\etc") |
| eventModel (global setting) | |
| Explicit name | Event model |
| Description | The "eventModel" global setting specifies which event model must be used by SPADS. SPADS is based on the asynchronous programming paradigm, with events, event handlers, callbacks etc. It can use either its own internal event model, or the Perl AnyEvent module if available on the system. Compared to the internal event model, AnyEvent is more efficient and makes it possible to integrate a lot of high-performance Perl modules such as web servers directly in the plugins. The default time slice used for the event loop is 0.5 second. This can be changed by specifying the desired value between parentheses after the event model type (unit is hundredth of second, default value is 50). |
| Format / Allowed values | <eventModelType> <eventModelType>(<timeSlice>) Examples: "auto": AnyEvent is used if available, otherwise the internal event model is used "internal": internal event model is used "AnyEvent": AnyEvent is used "internal(20)": internal event model is used, with an event loop time slice of 0.2 second instead of default 0.5 second |
| Default value | auto |
| floodImmuneLevel (global setting) | |
| Explicit name | Flood immune level |
| Description | When a user has an AutoHost access level superior or equal to this value, he is immune to flood protections. |
| Format / Allowed values | Integer |
| Default value | 100 |
| forceHostIp (global setting) | |
| Explicit name | Force hosting IP address |
| Description | By default, Spring server detects the latest IP protocol version and the corresponding network interfaces available on your system, and use them for hosting. But if the "forceHostIp" setting is set to a valid IP address, then Spring server will use this IP address for hosting instead of the auto-detected ones. If you have problem with hosting on your system and if you think it's related to IPv6, you may want to try setting "forceHostIp" to "0.0.0.0". |
| Format / Allowed values | <null>: the auto-detected interfaces are used for hosting Any valid IP address: the provided IP address is used for hosting |
| Default value | <null> |
| instanceDir (global setting) | |
| Explicit name | SPADS instance-specific dynamic data directory |
| Description | Location of SPADS instance-specific dynamic data (all SPADS instances running simultaneously on a system must use a different instance-specific directory). This directory path can be an absolute path or a path relative to varDir directory. If you run multiple SPADS instances simultaneously from a single SPADS installation, then you need to configure this setting so that each one of these instances uses a distinct instance-specific directory (for example you can use the lobby login to distinguish them, or numbers...). If you run only one SPADS instance from this SPADS installation, then you can leave this setting empty. |
| Format / Allowed values | <null>: no instance-specific directory configured (varDir directory is used instead), so only one SPADS instance can be launched from this SPADS installation Any writable directory: this directory is used for instance-specific data, it must be distinct for each SPADS instance launched from the same SPADS installation |
| Default value | <null> |
| kickBanDuration (global setting) | |
| Explicit name | Ban duration for kickBan command |
| Description | Duration of the ban applied when using !kickBan command (expressed in seconds, or in number of games if the value is suffixed with 'g') |
| Format / Allowed values | <nbOfSeconds>: <nbOfSeconds> is the ban duration expressed in seconds <nbOfGames>g: <nbOfGames> is the ban duration expressed in number of games |
| Default value | 300 |
| kickFloodAutoBan (global setting) | |
| Explicit name | Kick flood auto-ban thresholds |
| Description | Specifies the record period, the maximum number of times someone can be auto-kicked during this period before being auto-banned, and the duration of this automatic ban for battle lobby flood protection |
| Format / Allowed values | <nbAutoKick>;<delay>;<banDuration> where <nbAutoKick> is the maximum number of times someone can be auto-kicked before ban (integer) <delay> is the record period in seconds (integer) <banDuration> is the duration in minutes of the automatic ban for auto-kick floods (integer) |
| Default value | 2;120;5 |
| lobbyFollowRedirect (global setting) | |
| Explicit name | Follow lobby server redirection |
| Description | If enabled, SPADS will follow redirection orders from Spring lobby server. If disabled, it will keep trying to connect to the hostname specified by lobbyHost. |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| lobbyHost (global setting) | |
| Explicit name | Lobby server hostname |
| Description | Hostname or IP address of the Spring lobby server |
| Format / Allowed values | Hostname or IP address |
| Default value | lobby.springrts.com |
| lobbyInterfaceLogLevel (global setting) | |
| Explicit name | Lobby interface log level |
| Description | Log level of the lobby interface module |
| Format / Allowed values | 0: critical 1: errors 2: warnings 3: notices 4: information 5: debug (all messages sent and received on the interface are logged!) |
| Default value | 4 |
| lobbyLogin (global setting) | |
| Explicit name | AutoHost lobby name |
| Description | Name of the AutoHost in Spring lobby |
| Format / Allowed values | Any valid lobby login |
| Default value | %lobbyLogin% (set during installation, example: "Spads") |
| lobbyPassword (global setting) | |
| Explicit name | AutoHost lobby password |
| Description | Spring lobby password for the AutoHost account |
| Format / Allowed values | Any valid lobby password |
| Default value | %lobbyPassword% (set during installation, example: "abcdefgh") |
| lobbyPort (global setting) | |
| Explicit name | Lobby server port |
| Description | Port of the Spring lobby server |
| Format / Allowed values | Any valid port number |
| Default value | 8200 |
| lobbyReconnectDelay (global setting) | |
| Explicit name | Delay before reconnecting to lobby server |
| Description | When SPADS is disconnected from the lobby server, it tries to reconnect immediately. But when it fails to reconnect due to network problems, it waits this amount of seconds before trying to reconnect another time. A value of 0 disables reconnection. It is possible to specify a range, in this case the reconnect delay value is chosen randomly inside the range. |
| Format / Allowed values | Integer: number of seconds to wait before trying to reconnect <min>-<max>: range of seconds to wait before trying to reconnect (random delay mode) |
| Default value | 30 |
| lobbyTls (global setting) | |
| Explicit name | Lobby TLS mode |
| Description | Specifies if TLS encryption must be used for the connection to the lobby server. |
| Format / Allowed values | on: TLS is enabled (SPADS will exit if it can't establish a TLS encrypted connection to the lobby server) off: TLS is disabled (SPADS will use a plaintext connection to the lobby server) auto: TLS is enabled only if the required libraries are available |
| Default value | auto |
| localLanIp (global setting) | |
| Explicit name | LAN IP of the AutoHost |
| Description | If the AutoHost is connected to a LAN, this is the AutoHost IP address on this LAN. This parameter is used by the Spring lobby server to allow players from the same LAN to play on this AutoHost. |
| Format / Allowed values | <null>: the local LAN IP is auto-detected *: the AutoHost isn't connected to a LAN Any valid LAN IP address: this IP is sent to lobby server as local LAN IP |
| Default value | <null> |
| logBattleChat (global setting) | |
| Explicit name | Log battle lobby chat |
| Description | Specifies if battle lobby chat must be logged |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| logBattleJoinLeave (global setting) | |
| Explicit name | Log battle lobby join/leave |
| Description | Specifies if battle lobby join/leave messages must be logged |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| logChanChat (global setting) | |
| Explicit name | Log channel chat |
| Description | Specifies if channel chat must be logged |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 0 |
| logChanJoinLeave (global setting) | |
| Explicit name | Log channel join/leave |
| Description | Specifies if channel join/leave messages must be logged |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 0 |
| logDir (global setting) | |
| Explicit name | SPADS log directory |
| Description | Location of SPADS log files. This directory path can be an absolute path or a path relative to instanceDir directory. |
| Format / Allowed values | Any writable directory |
| Default value | %logDir% (set during installation, examples: "log", "/var/home/spring/spads/var/log", "C:\Program files\Spads\var\log") |
| logGameChat (global setting) | |
| Explicit name | Log game chat |
| Description | Specifies if game chat must be logged |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| logGameJoinLeave (global setting) | |
| Explicit name | Log game join/leave |
| Description | Specifies if game join/leave messages must be logged |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| logGameServerMsg (global setting) | |
| Explicit name | Log game server messages |
| Description | Specifies if game server messages must be logged |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| logPvChat (global setting) | |
| Explicit name | Log private lobby messages |
| Description | Specifies if private messages sent to the AutoHost must be logged |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 1 |
| majorityVoteMargin (global setting) | |
| Explicit name | Majority vote margin |
| Description | Specifies the percentage of the casted votes required for the vote to pass, in addition to the 50% already required by default. If set to zero, SPADS will use the standard majority vote system: the vote will pass if more than 50% of the casted votes are "yes". If not set to zero, SPADS will require supermajority (aka "qualified majority"): the required percentage of the casted votes for the vote to pass will be 50% + the configured value. If set to 50 (maximum value), unanimity will be required for the vote to pass. This global setting can also be overridden individually for each command in the commands rights configuration file (see commandsFile). The command-specific setting value must be declared at the end of the corresponding command declaration line, in parentheses. If multiple settings are overridden this way for a command, they must be separated by a comma. For example, to use specific values of "voteTime" and "majorityVoteMargin" for the "stop" command, the command declaration line could be: "[stop](voteTime:60,majorityVoteMargin:25)". |
| Format / Allowed values | Integer between 0 and 50 included |
| Default value | 0 |
| mapInfoCacheData (global setting) | |
| Explicit name | Map information cache data mode |
| Description | Data storage and sharing mode for the map information cache. This cache contains map specific data such as map options, size and start positions. When set to "private", the data file is stored in the instanceDir directory and is private to each SPADS instance. When set to "shared", the data file is stored in the varDir directory by default and is shared between all SPADS instances that use the same configuration. The default file name for the data file is "mapInfoCache.dat". When using shared mode, an alternate file name/location can be provided in parentheses after the "shared" keyword to use a specific non-default name/location for the data file. |
| Format / Allowed values | private: the map information cache is private to each SPADS instance and stored in the "mapInfoCache.dat" file located in the instanceDir directory shared: the map information cache is shared between all SPADS instances that use the same configuration and stored in the "mapInfoCache.dat" file located in the varDir directory shared(<fileLocation>): the map information cache is shared between all SPADS instances that use the same configuration and stored in the <fileLocation> file (if <fileLocation> is a relative path, it is relative to the varDir directory) |
| Default value | shared |
| masterChannel (global setting) | |
| Explicit name | AutoHost master channel |
| Description | If specified, the AutoHost will join this channel and listen to AutoHost commands in it. When running multiple AutoHosts, this can be useful to perform commands on severall AutoHosts at once. |
| Format / Allowed values | <null> (functionality disabled) Any valid lobby channel name |
| Default value | <null> |
| maxAutoHostMsgLength (global setting) | |
| Explicit name | Maximum AutoHost message length |
| Description | Whenever SPADS needs to send a message on the AutoHost interface, it will first split the message if needed so that each message will have a maximum length of <maxAutoHostMsgLength> bytes. |
| Format / Allowed values | Integer |
| Default value | 240 |
| maxBytesSent (global setting) | |
| Explicit name | Max bytes sent to lobby server |
| Description | Amount of bytes that can be sent to lobby server during send record period (see also sendRecordPeriod). Output flood protection is performed by queueing excessive data. |
| Format / Allowed values | Integer |
| Default value | 19000 |
| maxChatMessageLength (global setting) | |
| Explicit name | Maximum lobby chat message length |
| Description | Whenever SPADS needs to send a chat message to lobby server, it will first split the message if needed so that each message will have a maximum length of <maxChatMessageLength> bytes. |
| Format / Allowed values | Integer |
| Default value | 1024 |
| maxChildProcesses (global setting) | |
| Explicit name | Maximum number of child processes |
| Description | Specifies how many child processes can be spawned by SPADS simultaneously (other processes are queued). |
| Format / Allowed values | Integer |
| Default value | 16 |
| maxLowPrioBytesSent (global setting) | |
| Explicit name | Max low-priority bytes sent to lobby server |
| Description | Amount of low-priority bytes (private messages, command responses...) that can be sent to lobby server during send record period (see also sendRecordPeriod). Output flood protection is performed by queueing excessive data in a specific low-priority queue. |
| Format / Allowed values | Any integer smaller than the maxBytesSent value |
| Default value | 18000 |
| maxSpecsImmuneLevel (global setting) | |
| Explicit name | Spectator limit immune level |
| Description | When a user has an AutoHost access level superior or equal to this value, he is immune to maximum number of spectators limit (refer to maxSpecs). |
| Format / Allowed values | Integer |
| Default value | 100 |
| minVoteParticipation (global setting) | |
| Explicit name | Minimum vote participation |
| Description | This is the minimum percent of voters that must have voted manually for a poll to be taken into account by SPADS. If two values are provided (separated by ";" character), then the first one is used when there is no game in progress and the second one is used when a game is in progress. This global setting can also be overridden individually for each command in the commands rights configuration file (see commandsFile). The command-specific setting value must be declared at the end of the corresponding command declaration line, in parentheses. If multiple settings are overridden this way for a command, they must be separated by a comma. For example, to use specific values of "voteTime" and "minVoteParticipation" for the "stop" command, the command declaration line could be: "[stop](voteTime:60,minVoteParticipation:75)". |
| Format / Allowed values | <percent>: Integer between 0 and 100 included (a single value is used, no distinction is made whether a game is running or not) <percent1>;<percent2>: Integers between 0 and 100 included (<percent1> is used when no game is running, <percent2> is used when a game is running) |
| Default value | 50 |
| msgFloodAutoKick (global setting) | |
| Explicit name | Message flood auto-kick thresholds |
| Description | Specifies the record period and the maximum number of chat messages triggered by a user during this period in the battle lobby before auto-kick for flood protection |
| Format / Allowed values | <nbMsg>;<delay> where <nbMsg> is the maximum number of chat messages before kick (integer) <delay> is the record period in seconds (integer) |
| Default value | 7;7 |
| opOnMasterChannel (global setting) | |
| Explicit name | Operator on master channel |
| Description | Specifies if the AutoHost has operator access on the master channel. If so, it will be able to kick players from channel (for banned players or !bKick command) |
| Format / Allowed values | 0: no 1: yes |
| Default value | 0 |
| pluginsDir (global setting) | |
| Explicit name | SPADS plugins directory |
| Description | Location of SPADS plugins. This directory path can be an absolute path or a path relative to varDir directory. |
| Format / Allowed values | Any readable directory |
| Default value | plugins |
| preferencesData (global setting) | |
| Explicit name | Players preferences data mode |
| Description | Data storage and sharing mode for players preferences. When set to "private", the data file is named "preferences.dat". It is stored in the instanceDir directory and is private to each SPADS instance. When set to "shared", the data file is named "preferences.sqlite" by default. It is stored in the varDir directory by default and is shared between all SPADS instances that use the same configuration (this mode requires the DBD::SQLite Perl module). When using shared mode, an alternate file name/location can be provided in parentheses after the "shared" keyword to use a specific non-default name/location for the data file. |
| Format / Allowed values | private: players preferences are private to each SPADS instance and stored in the "preferences.dat" file located in the instanceDir directory shared: players preferences are shared between all SPADS instances that use the same configuration and stored in the "preferences.sqlite" file located in the varDir directory shared(<fileLocation>): players preferences are shared between all SPADS instances that use the same configuration and stored in the <fileLocation> file (if <fileLocation> is a relative path, it is relative to the varDir directory) |
| Default value | %preferencesData% (set during installation: "shared" if SQLite availability is detected, "private" else) |
| privacyTrustLevel (global setting) | |
| Explicit name | Privacy trust level |
| Description | Specifies the minimum access level required to see personal information about players (IP addresses, non-rounded skill values...) in the output of some commands (!list bans, !searchUser, !smurfs, !status and !whois). |
| Format / Allowed values | Integer |
| Default value | 130 |
| promoteChannels (global setting) | |
| Explicit name | List of promote channels |
| Description | Contains the list of lobby channels in which messages to promote current battle will be sent when !promote command is used. |
| Format / Allowed values | <null> (functionality disabled) <channel1>[ <password1>][;<channel2>[ <password2>][;...]] |
| Default value | <null> |
| promoteDelay (global setting) | |
| Explicit name | Promote delay |
| Description | Minimum delay in seconds between two promote messages (see also promoteChannels) |
| Format / Allowed values | Integer |
| Default value | 600 |
| promoteMsg (global setting) | |
| Explicit name | Promote message |
| Description | Message sent to promote channels when !promote command is used. %u is replaced by the user performing !promote command %p is replaced by the number of needed players for current expected battle structure (nbTeams x teamSize x nbPlayerById) %b is replaced by the battle name %o is replaced by the mod name %a is replaced by the map name %P is replaced by the number of players currently in battle %S is replaced by the number of spectators currently in battle %U is replaced by the number of users (players+spectators) currently in battle |
| Format / Allowed values | <null> (functionality disabled) Any string |
| Default value | %pplayer(s) needed for battle "%b" [%o, %a] (%u) |
| reCallVoteDelay (global setting) | |
| Explicit name | Re-call vote delay |
| Description | When a vote ends, SPADS prevents the user who started the vote to call another vote too fast, so that other users have some time to call a vote if they want to (vote flood protection). This is the minimum delay in seconds before someone can call another vote when his previous vote ended. |
| Format / Allowed values | Integer |
| Default value | 10 |
| restoreDefaultPresetDelay (global setting) | |
| Explicit name | Default preset restore delay |
| Description | Number of seconds before restoring the default preset when battle is empty. When set to 0, it disables the auto-restore default preset functionality. |
| Format / Allowed values | Integer |
| Default value | 30 |
| savedBoxesData (global setting) | |
| Explicit name | Saved map start boxes data mode |
| Description | Data storage and sharing mode for saved map start boxes. When set to "private", the data file is stored in the instanceDir directory and is private to each SPADS instance. When set to "shared", the data file is stored in the varDir directory by default and is shared between all SPADS instances that use the same configuration. The default file name for the data file is "savedBoxes.dat". When using shared mode, an alternate file name/location can be provided in parentheses after the "shared" keyword to use a specific non-default name/location for the data file. |
| Format / Allowed values | private: saved start boxes are private to each SPADS instance and stored in the "savedBoxes.dat" file located in the instanceDir directory shared: saved start boxes are shared between all SPADS instances that use the same configuration and stored in the "savedBoxes.dat" file located in the varDir directory shared(<fileLocation>): saved start boxes are shared between all SPADS instances that use the same configuration and stored in the <fileLocation> file (if <fileLocation> is a relative path, it is relative to the varDir directory) |
| Default value | shared |
| sendRecordPeriod (global setting) | |
| Explicit name | Send record period for output flood protection |
| Description | Period in seconds during which data sent to lobby server is measured to avoid flooding it (see also maxBytesSent and maxLowPrioBytesSent). A value of '0' disables output flood protection. |
| Format / Allowed values | Integer |
| Default value | 10 |
| sequentialUnitsync (global setting) | |
| Explicit name | Sequential unitsync mode |
| Description | Specifies if SPADS must use the unitsync library in sequential mode instead of parallel mode. When using sequential mode, all the SPADS instances with same varDir will synchronize themselves so that only one instance is calling the unitsync library at a time. |
| Format / Allowed values | 0: disabled 1: enabled |
| Default value | 0 |
| sharedDataRefreshDelay (global setting) | |
| Explicit name | Shared data refresh delay |
| Description | Delay in seconds between checks for updates in shared data files. This is the maximum delay before an update performed in shared data by one SPADS instance is applied to the other instances. A value of 0 disables periodic checks for updates in shared data files (in this case shared data are only refreshed when the instance needs to update it, to avoid overwriting changes made by other instances). |
| Format / Allowed values | Integer |
| Default value | 5 |
| simpleEventLogLevel (global setting) | |
| Explicit name | SimpleEvent log level |
| Description | Log level of the SimpleEvent module |
| Format / Allowed values | 0: critical 1: errors 2: warnings 3: notices 4: information 5: debug |
| Default value | 4 |
| spadsLogLevel (global setting) | |
| Explicit name | SPADS main log level |
| Description | Log level of the core SPADS component |
| Format / Allowed values | 0: critical 1: errors 2: warnings 3: notices 4: information 5: debug |
| Default value | 4 |
| springConfig (global setting) | |
| Explicit name | Spring config file path |
| Description | Absolute path of the main Spring configuration file (usually springsettings.cfg). This setting is not supported by spring-dedicated, it is only usefull when using SPADS with spring-headless. |
| Format / Allowed values | <null>: no configuration file is needed (spring-dedicated case), or default configuration file is used (spring-headless case) Absolute path to a correct Spring configuration file: configuration file used by spring-headless |
| Default value | <null> |
| springDataDir (global setting) | |
| Explicit name | Spring data directories |
| Description | Absolute pathes of the directories containing Spring base files, games or maps. Directories must be separated by colons (":") on Linux, and by semicolons (";") on Windows. When Spring version auto-management is enabled (cf autoManagedSpringVersion), Spring base files are automatically loaded, so only Spring data directories containing games or mods need to be declared here in this case. |
| Format / Allowed values | Any readable directories (absolute pathes) |
| Default value | %dataDir% (set during installation, examples: "/share/games/spring", "C:\Program files\Spring") |
| springServer (global setting) | |
| Explicit name | Spring server path |
| Description | Absolute path of the Spring server binary file. This setting must only be defined when a custom Spring installation is used with SPADS, i.e. when Spring version auto-management is disabled (cf autoManagedSpringVersion). |
| Format / Allowed values | <null> Any executable file absolute path |
| Default value | %springServer% (set during installation, examples: "/var/home/spring/bin/spring-dedicated", "C:\Program files\Spads\spring-headless.exe") |
| springServerType (global setting) | |
| Explicit name | Spring server type |
| Description | Type of Spring server binary used with SPADS. This setting must be defined if Spring version auto-management is enabled (cf autoManagedSpringVersion). |
| Format / Allowed values | <null>: the server type is auto-detected from spring server binary name (see springServer) dedicated headless |
| Default value | %springServerType% (set during installation, example: "dedicated") |
| springieEmulation (global setting) | |
| Explicit name | Springie emulation mode (deprecated) |
| Description | This setting is ignored since SPADS 0.13.39. |
| Format / Allowed values | on off warn |
| Default value | off |
| statusFloodAutoKick (global setting) | |
| Explicit name | Status flood auto-kick thresholds |
| Description | Specifies the record period and the maximum number of status changes triggered by a user during this period in the battle lobby before auto-kick for flood protection |
| Format / Allowed values | <nbMsg>;<delay> where <nbMsg> is the maximum number of status changes before kick (integer) <delay> is the record period in seconds (integer) |
| Default value | 8;8 |
| trustedLobbyCertificatesData (global setting) | |
| Explicit name | Trusted lobby certificates data mode |
| Description | Data storage and sharing mode for trusted lobby certificates. When set to "private", the data file is stored in the instanceDir directory and is private to each SPADS instance. When set to "shared", the data file is stored in the varDir directory by default and is shared between all SPADS instances that use the same configuration. The default file name for the data file is "trustedLobbyCertificates.dat". When using shared mode, an alternate file name/location can be provided in parentheses "shared" keyword to use a specific non-default name/location for the data file. |
| Format / Allowed values | private: trusted lobby certificates are private to each SPADS instance and stored in the "trustedLobbyCertificates.dat" file located in the instanceDir directory shared: trusted lobby certificates are shared between all SPADS instances that use the same configuration and stored in the "trustedLobbyCertificates.dat" file located in the varDir directory shared(<fileLocation>): trusted lobby certificates are shared between all SPADS instances that use the same configuration and stored in the <fileLocation> file (if <fileLocation> is a relative path, it is relative to the varDir directory) |
| Default value | shared |
| unitsyncDir (global setting) | |
| Explicit name | Unitsync library directory |
| Description | Absolute path of the unitsync library directory. This setting must only be defined when a custom Spring installation is used with SPADS, i.e. when Spring version auto-management is disabled (cf autoManagedSpringVersion). |
| Format / Allowed values | <null> Any readable directory containing a unitsync library (absolute path) |
| Default value | %unitsyncDir% (set during installation, examples: "/usr/local/lib", "C:\Program files\Spring") |
| updaterLogLevel (global setting) | |
| Explicit name | Updater log level |
| Description | Log level of the Updater module |
| Format / Allowed values | 0: critical 1: errors 2: warnings 3: notices 4: information 5: debug |
| Default value | 4 |
| useWin32Process (global setting) | |
| Explicit name | Use Win32 process |
| Description | Specifies if SPADS must use the native process spawning method to launch Spring server on Windows (using Win32 process instead of Perl fork emulation) |
| Format / Allowed values | 0: Perl fork implementation is used to spawn Spring server process 1: Win32 process is used to spawn Spring server process (allowed on Windows platform only) |
| Default value | 0 |
| userDataRetention (global setting) | |
| Explicit name | User data retention |
| Description | SPADS can store user data (IP addresses, ranks ...) so that IP bans and anti-smurf are possible. The "userDataRetention" global setting contains the number of days during which user data are kept even if the user hasn't been seen online, followed by the maximum number of IPs (useful to deal with dynamic IPs) and the maximum number of names (useful to track renames) that can be bound to an account, separated by ";". |
| Format / Allowed values | <retentionPeriod>;<maxIPs>;<maxNames> where <retentionPeriod> is the delay in days during which user data are stored ("-1" => data are kept forever, "0" => user data retention disabled) <maxIPs> is the maximum number of IPs bound to an account ("-1" => all IPs are kept, "0" => IPs aren't stored) <maxNames> is the maximum number of names bound to an account ("-1" => all names are kept, "0" => only one name is stored by account, "1" => max 2 names ...) |
| Default value | 0;0;0 |
| varDir (global setting) | |
| Explicit name | SPADS dynamic data directory |
| Description | Location of SPADS dynamic data. This directory path can be an absolute path or a path relative to SPADS installation directory. |
| Format / Allowed values | Any writable directory |
| Default value | %varDir% (set during installation, examples: "var", "/var/home/spring/spads/var", "C:\Program files\Spads\var") |
| voteTime (global setting) | |
| Explicit name | Vote time |
| Description | When a vote is called, this is the delay in seconds during which clients are allowed to vote. This global setting can also be overridden individually for each command in the commands rights configuration file (see commandsFile). The command-specific setting value must be declared at the end of the corresponding command declaration line, in parentheses. If multiple settings are overridden this way for a command, they must be separated by a comma. For example, to use specific values of "voteTime" and "minVoteParticipation" for the "stop" command, the command declaration line could be: "[stop](voteTime:60,minVoteParticipation:75)". |
| Format / Allowed values | Integer |
| Default value | 45 |