User Configuration File & Settings
Included in the mod download is battleconfig.cfg -- this is loaded by the game in order to
execute certain user settings. Place this anywhere in SRB2’s root or subdirectories for it to take
effect.
Settings
battleconfig_special <button 1, button 2, button 3, …>
Determines which buttons may trigger the special move command. Default is fire
battleconfig_guard <button 1, button 2, button 3, …>
Determines which buttons may trigger the parry/airdodge command. Default is firenormal
battleconfig_aimsight <on/off>
Toggles the aim sight helper when performing certain battle actions. Default is on.
battleconfig_dodgecamera <on/off>
Forces air dodge and stun break to be angled towards the camera, instead of towards the
held direction. Default is on.
Button Names
The button names that the config will read are as follows:
jump nextweapon weapon1
spin prevweapon weapon2
fire custom1 weapon3
firenormal custom2 weapon4
tossflag custom3 weapon5
camleft weapon6
camright weapon7
Console Variables & Commands
Developer
battledebug <flags>
Displays various debug info depending on the flags setting.
Flags Details
1 Gametype
2 Collision
4 Item Spawns
8 Player
battleversioninfo
Displays version info for BattleMod.
devcam <on/off>
Toggles the noclip free-roam spectator camera.
test
Performs function CBW_Battle.TestScript(player) if it has been externally defined by another
script.
Game Rules
battle_collision <on/off>
Toggles player collision outside of battle gametypes. Turn on friendlyfire to also enable
collision damage.
battle_guard <on/off>
Toggles the ability for players to parry attacks. (Always disabled in ringslinger and tag
gametypes)
battle_preround <on/off>
Toggles the pre-round mechanic in battle gametypes.
battle_maxrespawntime <3-30>
Sets the maximum number of seconds a player can be forced to wait before respawning. 10
by default.
battle_shieldstock <on/off>
Toggles the shield stock mechanic in battle gametypes.
battle_slipstream <on/off>
Toggles the slipstream mechanic.
battle_special <on/off>
Toggles special abilities. (Always disabled in ringslinger and tag gametypes)
battle_startrings <rings>
Sets the number of rings that players will spawn with in battle gametypes. Set to 50 by
default.
Continued...
battle_tailsdoll <value>
Sets when Tails Doll is allowed to appear in Battle gametypes. Set to 1 by default.
Value Details
0 Tails Doll never appears in game.
1 Tails Doll appears in game if there are not
enough players for a battle gametype to
progress.
2 Tails Doll always appears in game, regardless of
player count.
Item Spawns
item_global <on/off>
Toggles global item spawns. Refresh the map for this setting to take effect.
item_local <on/off>
Toggles local item spawns. Refresh the map for this setting to take effect.
item_rate <1-3>
Adjusts the frequency of item spawns, 1 being the slowest and 3 being the fastest; 2 by
default.
Survival Rules
survival_lives <lives>
Sets the number of lives that players spawn with in Survival modes.
survival_revenge <value>
Sets the revenge settings for Survival modes. Set to 2 by default.
Value Details
0 Revenge is disabled.
1 Players may respawn as jetty-syns when they
run out of lives.
2 Players may respawn as jetty-syns when they
run out of lives, and they can be brought back
into the game if they score a successful hit on an
enemy player.
survival_suddendeath <on/off>
Toggles the Sudden Death feature for Survival modes.
Control Point Rules
cp_bonus <points>
Sets the amount of points awarded to players for capturing the control point.
cp_create <radius> <height> <meter> <flip>
Spawns a control point at the player’s current location.
Continued...
cp_height <fracunits>
Sets the height level for all control points.
cp_meter <integer>
Sets the meter amount for all control points.
cp_next
Activates the next control point in the queue.
cp_radius <fracunits>
Sets the radius amount for all control points.
cp_shuffle
Re-shuffles the activation order of all control points currently on the map.
cp_spawnauto <on/off>
Determines whether control points may spawn at automatic panel locations.
cp_ spawnbomb <on/off>
Determines whether control points may spawn at explosion panel locations.
cp_spawnbounce <on/off>
Determines whether control points may spawn at bounce panel locations.
cp_spawngrenade <on/off>
Determines whether control points may spawn at grenade panel locations.
Continued...
cp_spawninfinity <on/off>
Determines whether control points may spawn at infinity panel locations. Disabled by default.
cp_spawnrail <on/off>
Determines whether control points may spawn at rail panel locations. Disabled by default.
cp_spawnscatter <on/off>
Determines whether control points may spawn at scatter panel locations.
cp_wait <seconds>
Sets the waiting period before the next control point is unlocked.
CTF Rules
ctf_flagdrop_graceperiod <seconds>
Sets the intangibility period for flags that have been dropped or tossed by players.
ctf_flagrespawn_graceperiod <seconds>
Sets the intangibility period for flags that have respawned at the base.
