If the server name, map name or other string value contains a space, you must enclose it within speech marks. For example, to set the server name to Control Monger the command would have to look like this: SvrName "Control Monger" and not like: SvrName Control Monger Each parameter documented in this file includes a symbol after its name to describe the type of data expected, they are: $ - String value - contains letters or numbers. If it contains spaces, the whole parameter must be enclosed with speech marks. % - Integer value - whole number such as 10, -439 or 384832 Any parameter shown in [] brackets is either optional or only required in certain circumstances (see its description for further info) If you are typing these commands into either the server or the remote control interface you must attach a / to the start. eg. /SvrName "Control Monger". You do not need to add this when placing commands in the SvrConfig.txt file. When starting a dedicated server you can pass it the following options in the command line: /config=???.txt Sets a config file instead of SvrConfig.txt /port=??? Sets a port number to use instead of 41230 If you want your dedicated server to download & install patches automatically make sure to change the Auto Patch=No line in cm.ini to Auto Patch=Yes Help [Command$] Displays either a list of commands or details on the requested command Command$ Command to display help for Example: Help MapListAdd Hide Hides the server window Example: Hide Show Shows the server window Example: Show Restart Restarts the application fully Example: Restart Quit Un-publishes the server and then ends the application Example: Quit Shutdown Alias of Quit Example: Shutdown SvrName Name$ Sets the servers name Name$ Name of the server (invalid characters will automatically be removed) Example: SvrName "Control Monger" SvrPass Password$ Sets the servers password Password$ Password for players trying to play on the server or set as blank (ie. "") to turn off. Note: Passwords are case sensitive Example: SvrPass pineapple SvrFullPass Password$ If the server is full this password can be used to allow authorized players to get on. Unlike the remote console passwords the user can not do any commands after they use this. Password$ Password for accessing the server when its full or set as blank (ie. "") to turn off. Note: Passwords are case sensitive Example: SvrFullPass eggplant SvrRemConPass Password$ Sets the servers remote control console password (admin access: full control) Password$ Password needed to use server commands from a client or set as blank (ie. "") to turn off. Note: Passwords are case sensitive Example: SvrRemConPass cdcase SvrRemConModPass Password$ Sets the servers remote control console password (moderator access: ban, kick, game restart and skip) Password$ Password needed to use server commands from a client or set as blank (ie. "") to turn off. Note: Passwords are case sensitive Example: SvrRemConModPass cdcase SvrRemConSupPass Password$ Sets the servers remote control console password (super admin access: full control) This password is here so hosting providers can maintain overall control of several servers, the end user can be given admin access and then encase they loose thier password it can be reset by the hosting provider via this password Password$ Password needed to use server commands from a client or set as blank (ie. "") to turn off. Note: Passwords are case sensitive Example: SvrRemConSupPass cdcase SvrMaxPlayers Players% Sets the player limit for the server Players% Maximum number of players, between 2 and 255 (note that 255 is available for the future when machines will be capable of such large games - it is highly unrecommended to use such high values at this time) Example: SvrPass 32 SvrPublish OnOff$ Sets if the server should be published or not on the internet OnOff$ Yes or No (Yes, Y, On or any number other than 0 will be treated as yes) Example: SvrPublish Yes SvrPostGameTime Time% Sets how many seconds the server will remain in the post game state (when the score from the last game is displayed before the next game begins) Time% Number of seconds (must be at least 15 - allows server time to load if needed) Example: SvrPostGameTime 15 SvrSuicideTime Time% Sets how many seconds the player has to wait to self-suicide or change team/bot Time% Number of seconds (between 0 and 60) Example: SvrSuicideTime 5 SvrPenalties Suicide%,Betray% The server can increase respawn time based on how many suicides/betrays have occurred recently (over the last 2 minutes for suicides and 5 minutes for betrays) Suicide% How many seconds to add per suicide (first is always free). Default is 1 Betray% How many seconds to add per betray (first is always free). Default is 5 Example: SvrPenalties 3,10 SvrBetrayLimit Quantity%,BanTime% Sets the number of betrays a player may have within 5 minutes without being banned for the given time. Defaults to 10 and then bans for 5 minutes Quantity% Maximum number of betrays (next betray will cause the ban). Set to 0 to turn this feature off BanTime% Number of seconds to ban for (e.g. 300 = 5 minutes) Example: SvrBetrayLimit 10,300 SvrMovementUpdates ClientUpdates$,ServerUpdates$ Sets how often the server and its clients send movement updates ClientUpdates$ Low, Medium, High or Ultra. Sets how often the clients send movement updates to the server ServerUpdates$ Low, Medium, High or Ultra. Sets how often the server sends movement updates to the clients Example: SvrMovementUpdates Medium,High SvrRemoteLog OnOff$ Forwards all server messages to the remote client OnOff$ Yes or No (Yes, Y, On or any number other than 0 will be treated as yes) Example: SvrRemoteLog Yes SvrRepatch Attempts to re-download and install the last patch Example: SvrRepatch SvrAllowNameReserves Sets if anyone playing can reserve his/her name using the ReserveName command OnOff$ Yes or No (Yes, Y, On or any number other than 0 will be treated as yes) Example: SvrAllowNameReserves Yes SvrMOTD Message$ Sets the servers message of the day - displayed to players when they join the server Message$ Up to 1KB or 16 lines of text, use the | character to signify the end of a line Example: SvrMOTD "Test MOTD:||Line 3|Line 4|Line 5" CustomMapList [Search$,Start%] Lists up to 20 installed custom maps, use the search option to find certain maps Search$ To display just certain maps use wildcards; eg. 'John*' or '*{AoS}'. Default will display all Start% Start from result number ?. Defaults to 1 Example: CustomMapList "*Urban Threat*" GameSet MapName$,GameType$,TeamMode$,RespawnMode$,RespawnTime%,ScoreLimit%[,Timeout%,AutoBalance$,Lives%,GTypeSpecific%] Starts a game with the given settings. Breaks out of the map cycle if its running. MapName$ Name of the map to use GameType$ Game type to use (this can either be short or long. eg. DM and "Death Match" are both acceptable) TeamMode$ Yes or No (Yes, Y, On or any number other than 0 will be treated as yes) RespawnMode$ Either Normal or Group RespawnTime% Time in seconds before a respawn ScoreLimit% Maximum number of points before the game ends Timeout% Number of seconds before the game ends (if the score limit is not reached). Defaults to 900 (15 minutes) AutoBalance$ Yes or No (Yes, Y, On or any number other than 0 will be treated as yes) - tries to keep teams balanced by setting new players team. Defaults to yes Lives% Number of lives or 0 for unlimited. Defaults to 0 GTypeSpecific% The meaning of this setting depends on the game type. For CTF games it is the number of flags available. Defaults to 0 (max available) Example: GameSet "Battle Dome",DM,Yes,Normal,50,300,No,5 GameBotLimit [,Bot1%,Bot2%,Bot3$,...] Sets the bot limits for the current game Bot1% Maximum number of the first type of bots. Defaults to the server player limit ...repeated Order: Heavy Gunner, Construction, Soldier, Repair, Sniper, Demolition, Spy Example: GameBotLimit 0,4,2,-1,4,1,4 GameReset Ends the current game and starts over using the same settings Example: GameReset GameRestart Alias for GameReset (see above) Example: GameRestart GameEnd Ends the current game and continues to the next one in the list (or restarts if not using maplist) Example: GameEnd GameSkip Alias of GameEnd Example: GameSkip MapList [Start%] Displays up to 20 of the current entries and their index numbers, use the start option to display entries past the first 20 Start% Start from number ?. Defaults to 1 Example: MapList MapListAdd MapName$,GameType$,TeamMode$,RespawnMode$,RespawnTime%,ScoreLimit%[,Timeout%,AutoBalance$,Lives%,GTypeSpecific%] Adds a game with the given settings to the map list. MapName$ Name of the map to use GameType$ Game type to use (this can either be short or long. eg. DM and "Death Match" are both acceptable) TeamMode$ Yes or No (Yes, Y, On or any number other than 0 will be treated as yes) - enables teams RespawnMode$ Either Normal or Group RespawnTime% Time in seconds before a respawn ScoreLimit% Maximum number of points before the game ends Timeout% Number of seconds before the game ends (if the score limit is not reached). Defaults to 900 (15 minutes) AutoBalance$ Yes or No (Yes, Y, On or any number other than 0 will be treated as yes) - tries to keep teams balanced by setting new players team. Defaults to yes Lives% Number of lives or 0 for unlimited. Defaults to 0 GTypeSpecific% The meaning of this setting depends on the game type. For CTF games it is the number of flags available. Defaults to 0 (max available) Example: MapListAdd "Battle Dome",DM,Yes,Normal,50,300 MapListSet Index%,MapName$,GameType$,TeamMode$,RespawnMode$,RespawnTime%,ScoreLimit%[,Timeout%,AutoBalance$,Lives%,GTypeSpecific%] Changes the given entry on the map list. Index% ID number of the entry to change (use MapList to retrieve a list of IDs) MapName$ Name of the map to use GameType$ Game type to use (this can either be short or long. eg. DM and "Death Match" are both acceptable) TeamMode$ Yes or No (Yes, Y, On or any number other than 0 will be treated as yes) - enables teams RespawnMode$ Either Normal or Group RespawnTime% Time in seconds before a respawn ScoreLimit% Maximum number of points before the game ends Timeout% Number of seconds before the game ends (if the score limit is not reached). Defaults to 900 (15 minutes) AutoBalance$ Yes or No (Yes, Y, On or any number other than 0 will be treated as yes) - tries to keep teams balanced by setting new players team. Defaults to yes Lives% Number of lives or 0 for unlimited. Defaults to 0 GTypeSpecific% The meaning of this setting depends on the game type. For CTF games it is the number of flags available. Defaults to 0 (max available) Example: MapListAdd "Battle Dome",DM,Yes,Normal,50,300 MapListBotLimit Index%[,Bot1%,Bot2%,Bot3$,...] Sets the bot limits for given map cycle entry Index% If 0 the newest entry in the list is assumed, otherwise use MapList to get index numbers (value ranges from 1 to the total number of entries) Bot1% Maximum number of the first type of bots. Defaults to the server player limit ...repeated Order: Heavy Gunner, Construction, Soldier, Repair, Sniper, Demolition, Spy Example: MapListBotLimit 0,4,2,4,4,1,4 MapListDelete Index% Deletes an entry from the map list Index% Index number of the entry to delete, use the MapList command to find out index numbers Example: MapListDelete 4 MapListClear Clears the entire map list Example: MapListClear MapListStart [Index%,Random$] Starts the map list (will loop back to the start once the end is reached) Index% Value between 1 and the current number of entries. If omitted 1 is assumed. Use the MapList command to check indexes Random$ Yes, Yes later or No (Yes, Y, On or any number other than 0 will be treated as yes). If on the list will be randomized now (unless used "Yes later") and each time the end of the list is reached. Defaults to no Example: MapListStart PlayerList [Search$,Start%] Lists up to 20 players on the server along with their connection ID, use the search option to find certain names Search$ To display just certain names use wildcards; eg. 'John*' or '*{AoS}'. Default will display all Start% Start from result number ?. Defaults to 1 Example: PlayerList PlayerAuth Name$ Displays the authority of the given player; anyone can use this command including the public Name$ Name of the player to check Example: PlayerAuth Tom PlayerKick ID% Kick a player from the server ID% The connection ID of the player (use the PlayerList command to get a list) Example: PlayerKick 22 PlayerKickAll [Exclude_Auth%] Kick all players except if they have the given authority or above. Exclude_Auth% Optional; if the players authority is higher or equal to this they will not be kicked (1 = moderator, 2 = admin, 3 = super admin) Example: PlayerKickAll 1 PlayerBan ID%,Minutes%[,Hours%,Days%,IPRange%] Bans a player from the server for the given amount of time. If you ban for 0 minutes the ban will be permanent with no time limit ID% The connection ID of the player (use the PlayerList command to get a list) Minutes% Number of minutes to ban for Hours% Number of hours to ban for. Defaults to 0 Days% Number of days to ban for. Defaults to 0 IPRange% Use this to ban a range of IPs based on the players IP. Values of 0-3 accepted (e.g. 2 = 64.238.*.*), defaults to 0 (only that one IP) Example: PlayerBan 22,0,2 BanList [Search$,Start%] Lists up to 20 current bans and how long they have left, use search option to find certain bans by name Search$ To display just certain names use wildcards; eg. 'John*' or '*{AoS}'. Default will display all Start% Start from result number ?. Defaults to 1 Example: BanList BanDelete ID% Deletes a ban with the given ID number ID% The ban ID to remove (use the BanList command to get a list) Example: BanDelete 3 ReserveName Password$[,Name$] Reserves a name with the given password so no one else can use it. To specify if the public can use this command see the SvrAllowNameReserves command Password$ Password to secure the name with Name$ Name to reserve (only moderators or above may give a specific name to reserve otherwise the current name is assumed) Example: ReserveName piglet ReserveList [Search$,Start%] Lists up to 20 reserved names, use the search option to find certain names Search$ To display just certain names use wildcards; eg. 'John*' or '*{AoS}'. Default will display all Start% Start from result number ?. Defaults to 1 Example: ReserveList ReserveDelete Delets a reserved name with the given ID number ID% The reserved name ID to remove (use the ReserveList command to get a list) Example: ReserveDelete 12 SaveConfig Saves the current configuration to the config file (eg. SvrConfig.txt) Example: SaveConfig NetStats Displays a snapshot of the current network statistics Example: NetStats