Console

This article or section is incomplete. It doesn't have all of the necessary core information on this topic. Please help the SRB2 Wiki by finishing this article.

Console showing a list of commands and variables after using the HELP command.

SRB2's console allows the user to control many of the game's options and to perform certain actions. Sometimes the same effects can be achieved using the menus, but the console is the only way of utilizing many features.

The console is accessed by pressing the key defined in the controls, which by default is ~ (tilde) on US keyboards and ` (backquote) on UK keyboards. This displays a prompt at which the user is expected to enter a command. To close the console, press the same key that was used to open it.

Some console commands and variables have options for the second player in splitscreen mode. Those will be shown with a forward slash. For instance, with "CHASECAM/CHASECAM2 <booleans>", CHASECAM toggles the first player's camera, and CHASECAM2 toggles the second player's camera.

Pressing the tab key when a command or var name is partly entered will auto-complete the command, pressing the tab key again will go to the next one.

Syntax

SRB2's console can be hard to figure out for new users, so here is a small guide on how to use it.

Special Characters

Semicolon (;)

This character will separate commands. For example, COLOR PURPLE; SKIN KNUCKLES will set your color to purple, then change your skin to Knuckles.

Quote (")

When a single string parameter contains a space, it must be enclosed in double quotes; hence BIND 1 "SAY HI" will work, but BIND 1 SAY HI will not.

Single string parameters containing certain characters must also be enclosed in double quotes if other characters are to be typed after them.

Here is a list of those characters (characters separated by spaces): { } ( ) ' :

An example of a case where this would be necessary is if one wanted to in the console connect to a server using a specific (non-default) port. Using CONNECT "192.168.1.5:5028" would work, but CONNECT 192.168.1.5:5028 would not work.

Script files

Main article: Script

A script file is a file that can be used to input things into the console without having to type them every time. You can make one by creating a new text file and inputting commands in it. Commands should always be written in lowercase (except for button names like KEY93), and they can be separated either by lines or by semicolons.

Example of tunebinds.txt:

bind 1 "tunes 45"
bind 2 "tunes 29"
bind 3 "tunes 93"
bind 4 "tunes 102"

To use a script file, just type EXEC <script filename> in the console. For the above example, typing EXEC TUNEBINDS.TXT would work.

autoexec.cfg

Main article: Script > autoexec.cfg

autoexec.cfg is a special type of script file that will allow you to run a series of commands on startup. It goes in the same directory as where config.cfg exists, but it is not there by default: you have to create it (use Notepad). This can allow for a default name, color, and skin for netgames, as well as other things such as BINDs and ALIASes.

adedserv.cfg

adedserv.cfg is a script file ran when starting a dedicated server. Like autoexec.cfg, it runs commands such as BIND and ALIAS.

Commands

ADDFILE <filename>

Adds a WAD, SOC or other file to the game. The file's name must be given with its extension. For instance: ADDFILE TEST.WAD; ADDFILE JUMP.SOC. After this command is used, the game immediately gets modified. Note that a file with a space in its name can either be added with quotes, like ADDFILE "TEST SPACE.WAD", or be entered using the DOS naming format. Also, if the file is a WAD that only contains music and/or sound effect lumps, adding it will not activate the cheat protection - in fact, these types of WADs can be added in the middle of netgames, even if you aren't the host. (The other players will not be required to download a file that doesn't activate the cheat protection.)

ALIAS <commands>

Creates an alias to execute multiple console commands. For instance, ALIAS SONIC "SKIN SONIC; COLOR BLUE" would make the console command SONIC turn you into a blue Sonic. Useful for scripting, as well as making autoexec.cfg files.

BAN <playername/node> <reason>

Kicks and bans a player from a netgame with the reason displayed as supplied. Once a player is banned, they can no longer join the server unless CLEARBANS is used. The maximum amount of bans is 100. If the command is used when ban.txt is full, the player will be kicked otherwise, without the ban being registered. Due to a bug, bans by server admins apparently ban the player but do not register the player on the ban list, thus degrading it to a KICK. (Server only, no Game Admins)

BIND <key> <command>

Makes a keystroke perform a console command. For instance, BIND \ SCREENSHOT would take a screenshot every time you press the \ key on the keyboard.

CD <action>

Performs one of a number of actions (listed below) relating to a music CD. (Only available to use if -usecd is set)

[on]
[off]
[remap]
[reset]
[open] (disabled)
[info]
[play <track>]
[loop <track>]
[stop]
[resume]

CECHO <message>

Displays <message> in the center of the screen. Backslashes indicate line breaks.

CECHODURATION <seconds>

Changes the duration a CECHO stays on screen, in seconds.

CECHOFLAGS <integer>

Sets optional values for CECHO. Add the values together to combine.

Decimal	Hexadecimal	Flag Name	Description
65536	`0x00010000`	V_NOSCALESTART	Do not scale the text's starting position, i.e., the top-left corner of the text. This will cause it to be placed as if the resolution was the default of 320x200, while still retaining text size for the resolution currently being used, assuming `V_NOSCALEPATCH` is not being used. This causes the text to be in the top-left in higher resolutions. Generally not recommended for use because it'll look different in different resolutions.
131072	`0x00020000`	V_WRAPY	Don't clamp texture vertically (in OpenGL mode).
262144	`0x00040000`	V_ALLOWLOWERCASE	Allow lowercase letters.
524288	`0x00080000`	V_NOSCALEPATCH	Do not scale the text's size. This will cause it to be sized as if the resolution was the default of 320x200, while still retaining the text's starting position for the resolution currently being used, assuming `V_NOSCALESTART` is not being used. This causes the text to be smaller in higher resolutions. Generally not reccomended for use because it'll look different in different resolutions.
1048576	`0x00100000`	V_YELLOWMAP	Text is colored yellow.
2097152	`0x00200000`	V_SNAPTOTOP	Text begins at the top of the screen.
4194304	`0x00400000`	V_TRANSLUCENT	Text is 50% translucent.
8388608	`0x00800000`	V_SNAPTOBOTTOM	Text ends at the bottom of the screen.
16777216	`0x01000000`	V_WRAPX	Don't clamp texture horizontally (in OpenGL mode).
33554432	`0x02000000`	V_WORDWRAP	Text is word wrapped.
67108864	`0x04000000`	V_8020TRANS	Text is 80% translucent.
134217728	`0x08000000`	V_GREENMAP	Text is colored green.
268435456	`0x10000000`	V_TOPLEFT	Text begins at the top-left corner.
536870912	`0x20000000`	V_RETURN8	Makes line breaks have no distance between them vertically.
1073741824	`0x40000000`	V_SNAPTOLEFT	Each line of text starts at the left edge of the screen.
2147483648	`0x80000000`	V_SNAPTORIGHT	Each line of text ends at the right edge of the screen.

CHANGECONFIG <filename>

Saves the current config and loads another.

CHANGETEAM/CHANGETEAM2 <red/blue/spectator/playing>

Changes the team you are currently playing for. You can also use this command to become a spectator, clearing your score and turning you into an invisible bystander. Doesn't work in Co-op and Race.

CHARABILITY <1/2> <value>

Changes the character ability of your player. CHARABILITY 1 sets the ability as shown in the table below. CHARABILITY 2 lets you choose between spindash (0), multi-ability without jumpspin (1) and no spin (2). You must have DEVMODE enabled to use this command.

Value	Ability
0	Sonic Speed Thok
1	Tails Fly
2	Knuckles Glide/Climb
3	Double Jump
4	Super Sonic Float
5	Float with Slow Descent (similar to E-102 Gamma's booster powerup in Sonic Adventure)
6	Swim (basically the flying action only allowed underwater)
7	Homing Attack
8 and above	No ability

CHARSPEED <parameter> <value>

Changes one of the character speeds of your player. Possible parameters are normalspeed, runspeed, thrustfactor, accelstart, acceleration and actionspd. Note that this command accepts values that would not normally be possible to set in a Character WAD, even negative values. You must have DEVMODE enabled to use this command.

CLEARBANS

Clears all bans. Users that were banned will be able to join again.

CLEARSCORES

Resets each player's score to 0. This also works in Single Player games.

CLS

Clears the console buffer.

CONNECT <ip>

Connects to the specified IP address. If no IP is specified, it will search on the LAN for a game. Note that to connect on a specific port, one must use this format: CONNECT "<ip>:<port>".

COUNTMOBJS

Counts all of the Objects in a level and lists them in the console.

CSAY <message>

Sends a message to everyone within a netgame in CECHO format. Only the host or server administrators can use this command.

DEVMODE <integer>

Activates development mode. See DEVMODE for deeper info.

DISPLAYPLAYER

Shows the number of the current player being displayed.

ECHO <message>

Echoes whatever you type in the console. Useful for scripting.

ENGLISH

English Keymap.

EXEC <filename>

Executes a script file.

EXITGAME

Exits the current game.

EXITLEVEL

Exits the current level (Server or Game Admin only, unless ALLOWEXITLEVEL is enabled). This cannot be used in Single Player.

GAMETYPE

Shows the current gametype as one of the following numbers:

Number	Game type
0	Single Player / Co-op
1	Match / Team Match
2	Race / Classic Race
3	Tag / Hide & Seek
4	Capture the Flag

GETALLEMERALDS

Awards you with all 7 Chaos Emeralds. You must have DEVMODE enabled to use this command.

GETPLAYERNUM

Lists all of the players in the game, their number in the array, and their node numbers.

GOD

Enables/disables Sissy Mode, which makes the player totally invincible to everything, even bottomless pits and crushers. Activates the cheat protection. Enemies that try to hurt the player will instead go right through the player. Disabled in Multiplayer.

GR_STATS

(OpenGL only, cannot be set in Software)

GRAVFLIP

Flips the direction which gravity pulls the player towards. You must have DEVMODE enabled to use this command.

HELP <command>

If used without an argument, will list all console commands, both commands and variables (some variables will not be displayed, such as a few cheats). If provided with the name of a command, more detailed help for that command will be provided, if available. For variables it displays flags, range and current value.

Flag name	Meaning
AUTOSAVE	Saves to config.cfg when changed
FLOAT	Takes floating values (i.e. non-whole numbers)
NETVAR	Syncronised for everyone over netgames
ACTION	Calls a function when changed
CHEAT	Triggers cheat protection when modified

HURTME <value>

Hurts the player by a given amount. 10000 is instant kill, while all other values will simply hurt the player. You must have DEVMODE enabled to use this command.

ISGAMEMODIFIED

Activating GOD mode modifies the game, and checking for modifications again will return true.

Checks if the game is modified and if secrets can be unlocked, and returns the result to the console.

JUMPTOAXIS <axis number>

Teleports NiGHTS Super Sonic to the specified Axis. You must have DEVMODE enabled to use this command. Note that improperly using this command can cause SIGSEGVs.

KICK <playername/node> <reason>

Kicks a player out of a netgame. A reason can be typed in after the command. (Server or Game Admin only)

LISTSERV

Retrieves and displays a list of hosted games from the Master Server.

LISTWAD

Displays a list of WADs attached to the game. WADs listed with an * are the game's default WADs.

LOADCONFIG <filename>

Loads a new config without saving.

LOGIN <password>

Attempts to login as a netgame administrator. The password is set by the host.

MAP MAP<value>

Changes the level. For instance, to warp to Greenflower Zone Act 1, type MAP MAP01. To know which map number a level is, get a WAD editor, look in MAINCFG, find the map name, and look at its corresponding level number. If the level number (xx) is 99 or less, the map is MAPxx. If the level is greater than 100, consult the List of Extended Map Numbers.

Alternatively, for official SRB2 maps, consult the list of levels.

The MAP command takes two (or three, if DEVMODE is enabled) optional parameters:

-GAMETYPE <game mode name or number>

Specifies the game mode to use with the new map, e.g., MAP MAP01 -GAMETYPE TAG. Also you can type the gametype's number instead of its name, e.g., MAP MAP01 -GAMETYPE 3. See below for the numbers associated with each gametype:

Number	Game type
0	Single Player / Co-op
1	Match
2	Race
3	Tag
4	Capture the Flag
42	Team Match
43	Classic Race
44	Hide and Seek

-FORCE

Forces the game to warp to the map, even if it does not support the current gametype, e.g. MAP MAP01 -FORCE when not in Single Player or Co-op mode. To keep from having to enter -FORCE all the time, use SKIPMAPCHECK.

-NORESETPLAYERS

Makes the game warp to the map without resetting player data like lives, score, etc.; as if the player had advanced to the map normally. You must have DEVMODE enabled to use this parameter.

MOD_DETAILS

Lists the ID, version and codebase of the executable currently used.

MEMFREE

Displays memory usage statistics.

MOTD <message>

Sets a 'Message of the day' that is displayed in a player's chat text when they join your server. Backslashes (\) indicate line breaks. Note that due to a current glitch, sometimes trying to change the message after setting one will instead cause the new messages to pile up at the end of the previous ones. (Server or Game Admin only)

NOCLIP

Increases gravity and turns off clipping. This allows the player to go through the thok barrier as well as immediately move on top of raised ground no matter how high the sector is. Also, Things cannot be touched. Activates the cheat protection. This is disabled in Multiplayer.

NODES

Lists all of the players in the game and their player numbers.

NUMTHINKERS <number>

Counts the number of thinkers, based off of the value inputted. Useful for development and code testing.

ORDERPIZZA

A command that simply prints a line of text to the console saying "<name> has ordered a delicious pizza." However, it will not work unless you give it an address, a topping, and a size. Usage:
ORDERPIZZA -SIZE <anything you want> -ADDRESS <anything you want> -TOPPING <anything you want>

Note: Keying ORDERPIZZA 1 2 3 4 5 or ORDERPIZZA 1 2 3 4 5 6 in the console will have the same effect because none of the parameters mean anything. Only the number of parameters is checked.

PASSWORD <value>

Changes the server password to the given value. Host or Server only.

PAUSE

Pauses the game. Reuse it to unpause. (It also works if you press the Pause/Break button on your keyboard)

PING <player/node>

Sends a command that tells you the ping of a player in milliseconds, which tells you how long the connection needs to respond. If used without a player name, it lists the ping for all players.

PLAYDEMO <filename>

Plays back a recorded demo.

PLAYINTRO

Plays the opening intro. Due to a bug with this command, the music that was playing when you use this command will momentarily keep playing.

QUIT

Exits the game immediately, skipping all menus and displays.

RELOADBANS

Reloads an existing ban.txt and bans all of the included IP addresses.

RESETCAMERA

Resets the camera, just as if you had pressed the "reset camera" key.

RESETEMERALDS

Sets your emerald count to 0. You must have DEVMODE enabled to use this command.

RTELEPORT -x <X distance> -y <Y distance> -z <Z distance>

Teleports you relative to your current location. You must have DEVMODE enabled to use this command.

RUNSOC <socfile.soc or lumpname>

Runs a SOC file.

SAVECHECKPOINT

Creates a temporary and invisible starpost on your current location. You must have DEVMODE enabled to use this command.

SAVECONFIG <filename>

Saves the current configuration.

SAY <message>

Sends a message to everyone.

SAYTEAM <message>

Sends a message to your team. Only works if the gametype is Team Match, Tag, Hide & Seek, or CTF.

SAYTO <playername/node> <message>

Sends a message to a specific player. If the player has parentheses in his/her name, the player name must be enclosed in quotes.

SCALE <percent>

Scales the player to a percentage of their original size. You must have DEVMODE enabled to use this command.

SERVERCHANGETEAM <playername/node> <red/blue/spectator/playing/it/notit>

Changes the current team any player is on. Can also be used to force a player to spectate, or to bring them into the game from spectating. In Tag/Hide & Seek, you can use this to make players IT or not IT (at least one person must be IT), but you can no longer do so once the HIDETIME has run out. (Server or Game Admin Only)

SCREENSHOT

Takes a screenshot of the display. Note that if you don't bind this to a key, it will show the console in the screenshot. Alternatively, press the F8 key.

SETCONTROL/SETCONTROL2 <control name> <key name>

Manually changes the controls of 1P and 2P. Note that both the control name and key name need to be enclosed in quote marks. You can additionally set a second key to the selected control by adding it on the end, with the same format as the first key name. See config.cfg for examples of how this command is used.

Also note that some keys will be known under certain names in SRB2:

"LCTRL" or "CTRL": Left Ctrl
"RCTRL": Right Ctrl
"LALT" or "ALT": Left Alt
"RALT"": Right Alt
"LSHIFT" or "SHIFT": Left Shift
"RSHIFT": Right Shift

"LEFTWIN": Left Windows key
"RIGHTWIN": Right Windows key

"NUMLOCK": Num Lock
"SCROLLLOCK": Scroll Lock

"PGUP": Page Up
"PGDN": Page Down
"INS": Insert
"DEL": Delete
"KEYPAD <keypad key>": Keypad key

"MOUSE1": Left Mouse button
"MOUSE2": Right Mouse button

"KEY0": No control set
"KEY96": US keyboard: ~ (tilde), UK keyboard: ` (backquote)
"KEY128": Print Screen (or \ (backslash) (UK keyboard-only))
"KEY255": Pause/Break

SHOWBANLIST

Lists all bans made in-game and in the ban.txt inside the SRB2 folder along with the ban reasons.

SHOWMAP

Shows what map you're currently on.

SHOWSCORES

Shows the game scores of everyone.

SHOWTIME

Shows the time (and, if applicable, the timelimit) of a game.

SKYNUM <number>

Changes the sky. You must have DEVMODE enabled to use this command. Also displays the current sky if no slot value is given. Refer to Flats and Textures/Skies for a complete list of skies with samples.

SOUNDTEST <number>

Plays a sound based on what number you entered. Refer to the List of Sounds for a complete list of sounds and their numbers.

STARTMOVIE

Creates a movie file, which will output as an animated PNG.

STOPDEMO

Stops the currently running demo.

STOPMOVIE

Tells the game to stop the function of STARTMOVIE.

TELEPORT -x <X location> -y <Y location> -z <Z location>

Teleports you directly to the coordinates you specified. You must have DEVMODE enabled to use this command.

TIMEDEMO

Plays back a demo at the highest possible speed. Useful for benchmarking.

TOGGLE <variable>

Allows you to toggle certain console variables on and off. In most cases, this works only for on/off and yes/no variables. TOGGLE COLOR allows you to cycle through colors. TOGGLE SKIN currently doesn't work.

TUNES <slot> <speed>

Changes the song that's playing and its speed (optional). Speed is given by positive and real number (i.e.: 0.5, 0.22, 1.3). Also displays the current tune if no slot value is given. Refer to MusicSlots for a list of available tunes.

VERIFY <playername/node>

Gives a player administrative privileges in a netgame. Only one person may be verified at a time.

VERSION

Tells you the version of SRB2 you are using.

VID_MODE <mode number>

Sets your resolution. To see what number equals what resolution, use VID_MODELIST.

VID_MODEINFO <mode number>

Gives out information about the specified mode. If used without a mode number, gives out information about the current resolution.

VID_MODELIST

Lists all available resolutions and their corresponding mode numbers.

VID_NUMMODES

Shows the number of available resolutions.

WAIT <tics>

Waits a certain number of game tics before executing the next command. Useful for scripting.

WRITETHINGS

Use this after activating OBJECTPLACE mode to place new Things. This will save the Things to NEWTHINGS.lmp in your SRB2 folder. Then, using XWE or a similar lump editor, you may rename NEWTHINGS.lmp to THINGS.lmp, and replace the existing THINGS lump for the level whose Things you have modified. Remember, you can't modify zones.dta, so to create new things for an official level, you'll have to copy the map and its nodes to a new WAD, then replace the THINGS lump.

Variables

Variables are unlike commands in that instead of directly performing an action, you change a variable, which in turn would make a difference in the game. The command starts the line, then a value follows to set it. A value can either be boolean, an integer, a decimal number, or something completely different, depending on what the command calls for. Note that some of these commands have equivalents in the game's "Options" menu.

A boolean variable is one which can either be on or off. For instance, CHASECAM ON turns on the camera, and CHASECAM OFF turns it off. You can also use 1 instead of ON, and 0 instead of OFF. Some boolean variables still use YES and NO, so try that if it doesn't work.

An integer is a number with nothing after the decimal point.

A decimal number is a number that may or may not have something after the decimal point.

Console variables marked like this CONSVAR/CONSVAR2 are used for split-screen, e.g., CAM_DIST/CAM2_DIST. CAM_DIST is for the camera distance of player 1. CAM2_DIST is for the camera distance of player 2.

1UP <integer>

HELP flags: NETVAR;CHEAT

Sets the availability of Extra Life Monitors in a game. 0 is off, 1 is low, 2 is medium (default) and 3 is high. Cheats must be enabled in order to change this. (Server or Game Admin only)

ADVANCEMAP <integer>

HELP flags: NETVAR

Sets whether or not to advance to the next map in the cycle when a round finishes in any mode except Co-op or Single Player. 0 = Off (repeats the same map), 1 = Next Map in Cycle, 2 = Random Map. Can also be set under Network Options. (Server or Game Admin only)

ALLCAPS <boolean>

Makes all letters in the console uppercase.

BLAMECFAIL <boolean>

Enabling this allows the host to see who is causing consistency failures in a netgame. Can only be used by the host or server (not game admins).

BOMBSHIELD <integer>

HELP flags: NETVAR;CHEAT

Sets the availability of Armageddon Shields in a game. 0 is off, 1 is low, 2 is medium (default) and 3 is high. Cheats must be enabled in order to change this. (Server or Game Admin only)

CAM_DIST/CAM2_DIST <decimal>

HELP flags: FLOAT

Changes the distance of the camera. You cannot use a negative value to zoom in. Default is 128 for normal mode, 192 for analog control, and 320 when playing as NiGHTS Super Sonic.

CAM_HEIGHT/CAM2_HEIGHT <decimal>

HELP flags: FLOAT

Changes the height of the camera. Default is 20.

CAM_ROTATE/CAM2_ROTATE <integer>

HELP flags: ACTION

Changes the angle of the camera's rotation.

CAM_ROTSPEED/CAM2_ROTSPEED <integer>

Changes the rotation speed of the camera (Analog Control only). Default is 10.

CAM_SPEED/CAM2_SPEED <decimal>

HELP flags: FLOAT

Changes the speed of the camera. Default is 0.25.

CAM_STILL/CAM2_STILL <boolean>

Forces the camera angle to freeze in place instead of following the player.

CD_UPDATE <boolean>

HELP flags: ACTION

If false, loops the current CD background music track. If true, advances to the next.

CD_VOLUME <integer>

HELP flags: ACTION

Apparently adjusts the volume of the CD music BGM (this command may be deprecated). Maximum value is 31.

CHASECAM/CHASECAM2 <boolean>

HELP flags: ACTION

Turns the camera on and off. If off, the first-person view is used.

CHEATS <boolean>

HELP flags: NETVAR;ACTION

Enables cheats in a multiplayer game. Once enabled, cheats cannot be disabled until the server has ended.

COLOR/COLOR2 <color>

HELP flags: ACTION

Changes your player's color. Only works in multiplayer, while standing still. The possible values are as follows:

Value	Color
1	Cyan
2	Peach
3	Lavender
4	Silver
5	Orange
6	Red
7	Blue
8	Steel Blue
9	Pink
10	Beige
11	Purple
12	Green
13	White
14	Gold
15	Yellow (Disabled in Match)

CON_BACKCOLOR <color>

HELP flags: AUTOSAVE

Changes the color of the console. Both the colors names or their number values can be used here.

Value	Color
0	White
1	Orange
2	Blue
3	Green
4	Gray
5	Red

CPUAFFINITY

HELP flags: AUTOSAVE;ACTION

CPUSLEEP <integer>

See also: w:Sleep (system call)

HELP flags: AUTOSAVE

Calms down a number of common Windows processes to reserve CPU power for SRB2, by telling the program to sleep for a set period of time. Highly recommended for older computers or computers struggling with its OS. Values range from -1 to 28, -1 being off and 0 to 28 being the time to sleep, measured in milliseconds.

CROSSHAIR/CROSSHAIR2 <integer>

HELP flags: AUTOSAVE

Sets the type of crosshair used in first-person view. 0 is off, 1 is cross, 2 is angle, and 3 is point. Default is 1.

DIGMUSICVOLUME <integer>

HELP flags: AUTOSAVE

Adjusts the volume of the digital music (.OGG) BGM. Maximum value is 31. Can also be set under Sound Options, but this command can be useful for scripting.

DOWNLOADING <boolean>

Allows/disallows WAD downloading in a netgame.

EGGMANTV <integer>

HELP flags: NETVAR;CHEAT

Sets the availability of Eggman Monitors in a game. 0 is off, 1 is low, 2 is medium (default) and 3 is high. Cheats must be enabled in order to change this. (Server or Game Admin only)

FLAGTIME <integer>

HELP flags: NETVAR

Sets how long a CTF flag will stay in place once thrown or dropped, in seconds. Default is 30, Maximum Value is 300. Can also be set under Gametype Options. (Server or Game Admin only)

FORCESHIELD <integer>

HELP flags: NETVAR;CHEAT

Sets the availability of Force Shields in a game. 0 is off, 1 is low, 2 is medium (default) and 3 is high. Cheats must be enabled in order to change this. (Server or Game Admin only)

FORCESKIN <boolean>

HELP flags: NETVAR;ACTION

Forces all players in the game to use the character that the server is using. Can also be set under Network Options. (Server or Game Admin only)

FRIENDLYFIRE <boolean>

HELP flags: NETVAR

Enables or disables friendly fire among teammates. (Server or Game Admin only)

FULLSCREEN <boolean>

HELP flags: AUTOSAVE;ACTION

GAMMA <integer>

HELP flags: AUTOSAVE;ACTION

Changes the gamma level. Maximum value is 4, minimum value is 0.

GR_ANISOTROPICMODE <integer>

HELP flags: ACTION

(OpenGL only, cannot be set in Software)

GR_BETA

(OpenGL only, cannot be set in Software)

GR_CLIPWALLS <on/off>

(OpenGL only, cannot be set in Software)

HELP flags: AUTOSAVE;ACTION

Sets the brightness of the red color. (OpenGL only)

GR_MD2 <off/on/old>

Toggles MD2 Models on/off. 0 is Off, 1 is On, and 2 is Old. (OpenGL only, cannot be set in Software)

GR_SOLVETJOIN <on/off>

(OpenGL only, cannot be set in Software)

GR_TRANSLUCENTHUD <integer>

HELP flags: AUTOSAVE;ACTION

Sets the HUD to be translucent. Default value is 255. (OpenGL only)

GRAVITY <decimal>

HELP flags: NETVAR;FLOAT;ACTION

Changes the gravity. Default value is 0.5. (Single Player/Server or Game Admin only)

GRID <integer>

Snaps Things placed with OBJECTPLACE to the nearest x/y map co-ordinates of multiples of the value set by this command. Setting this to 0 will turn off this feature. (Broken)

HIDETIME <integer>

HELP flags: NETVAR;ACTION

Sets the number of seconds the non-IT players in Tag and Hide & Seek have to flee before the IT player can move. The value cannot exceed the time limit of the game, and if the time limit is disabled then HIDETIME can't be adjusted. Can also be set under Gametype Options. (Server or Game Admin only)

HOMREMOVAL <boolean>

HELP flags: AUTOSAVE

When activated, all missing flats and textures are replaced with a black wall. This prevents the Hall of Mirrors glitch from happening, but causes the framerate to drop considerably. As of 2.0.6, it defaults to off due to framerate problems in 2.0.5.

INTERNETSERVER <boolean>

HELP flags: ACTION

Enables or disables advertising of the game on the Master Server. Can also be set under Server Options.

INTTIME <integer>

HELP flags: NETVAR

Changes the intermission time (in seconds) between multiplayer levels. (Server or Game Admin only)

INVERTMOUSE/INVERTMOUSE2 <on/off>

HELP flags: AUTOSAVE

Determines whether or not the up and down looking of the mouse should be inverted. This can also be set in Mouse Options for player one, but not for player two.

INVINCIBILITY <integer>

HELP flags: NETVAR;ACTION

Sets the availability of Invincibility in a game. 0 is off, 1 is low, 2 is medium (default) and 3 is high. Cheats must be enabled in order to change this. (Server or Game Admin only)

JOINNEXTROUND <boolean>

HELP flags: NETVAR

KILLINGDEAD <boolean>

HELP flags: NETVAR

If enabled, hitting an enemy or popping a monitor causes damage to yourself 75% of the time. This simulates a glitch from the original Sonic Robo Blast. (Single Player/Server or Game Admin only)

LIMITDRAW <boolean>

HELP flags: AUTOSAVE

Limits drawing of Things in the OpenGL render. Things that are not close to the player will not be drawn. This can help improve framerate, but may look odd.

HELP flags: AUTOSAVE;ACTION

Changes your nickname for multiplayer. It may not start with a numeral. For names with spaces, put the name between quotes.

NETSTAT <boolean>

Shows network statistics. Can be used in Single-Player. GAMEMISS estimates the amount of lag a map has. With one person, it only estimates framerate lag for that specific computer.

NETTIMEOUT <integer>

HELP flags: ACTION;AUTOSAVE

Minimum value is 5 tics, Maximum value is 2100 tics (60 seconds), Default is 525 (15 seconds).

NUMLAPS <integer>

HELP flags: NETVAR;ACTION

Sets the number of laps on a Circuit mode track. Maximum is 50. Can also be set under Gametype Options. (Server or Game Admin only)

OBJECTPLACE <boolean>

HELP flags: ACTION

OBJECTPLACE is enabled in the console. It acts like the Debug Mode in classic Sonic games.

Turns object placement mode on or off. It is recommended that it is not enabled and disabled often in one session of SRB2. Adding too many objects in a map will cause SRB2 to crash. Disabled in multiplayer.

OBJFLAGS <integer>

OFFSETSHADOWS <boolean>

HELP flags: AUTOSAVE

Intended for use with the SHADOW variable. If set to on, shadows will fall farther away the higher up the sprite is. This is more realistic, but turning it off might be considered more practical since the shadows serve as a marker for the location of the Object. For example, if set to off, the shadow of a player in midair will show exactly where he will land. Defaults to off.

ONTOP <never/off/on>

Determines if SRB2 should be on top of other windows. Off disables the command's effect, on keeps the window above others at all times, while never keeps the window below all others at all times. Currently does not function.

OVERTIME <boolean>

HELP flags: NETVAR

If enabled, a time-limited round of Match or CTF doesn't end as long as two or more players/teams lead with the same score. Defaults to on. (Server or Game Admin only)

PAUSEPERMISSION <boolean>

HELP flags: NETVAR

If set to 1, all clients can pause a netgame; otherwise, only the server can pause the game. (Server or Game Admin only)

PLAYDEMOSPEED <integer>

Changes the speed at which a demo is played back.

REALNAMES <boolean>

Shows the real names of Sonic Team Junior's staff in the credits, instead of their online aliases.

RECYCLER <integer>

HELP flags: NETVAR;CHEAT

Sets the availability of Recyclers in a game. 0 is off, 1 is low, 2 is medium (default) and 3 is high. Cheats must be enabled in order to change this. (Server or Game Admin only)

RENDERVIEW <on/off>

When on, it's on the player. When off, a giant HOM covers the entire screen.

RESETMUSIC <boolean>

HELP flags: AUTOSAVE

Resets the in-game music. When enabled, in Single Player the music will start over after you die, like in most Sonic games. The game remembers what you set this to.

RESPAWNITEM <boolean>

HELP flags: NETVAR;ACTION

Enables or disables items to respawn. (Server or Game Admin only)

RESPAWNITEMTIME <integer>

HELP flags: NETVAR;CHEAT

Sets how long, in seconds, it takes for an item to respawn. Default is 30, Maximum Value is 300. If set to 0, the item will respawn on the next tic. (Server or Game Admin only)

RINGSHIELD <integer>

HELP flags: NETVAR;CHEAT

Sets the availability of Attraction Shields in a game. 0 is off, 1 is low, 2 is medium (default) and 3 is high. Cheats must be enabled in order to change this. (Server or Game Admin only)

RINGSLINGER <boolean>

HELP flags: NETVAR;ACTION;CHEAT

Allows the player to throw rings at a enemy. (DEVMODE/Server or Game Admin only)

RUNSCRIPTS <boolean>

Toggles whether or not to run scripts uninitiated by the player. This includes map scripts and level-start scripts.

Enabling this will display the IP of joining players to the host. (Server or Game Admin only)

SKIN/SKIN2 <name>

HELP flags: ACTION

Changes your player's character. Only works in multiplayer, while standing still. Note that the player's color is changed to the default color for the character; e.g. "skin knuckles" transforms you into a red Knuckles.

SKIPMAPCHECK <boolean>

HELP flags: AUTOSAVE

If enabled, the game will not check to see if a map supports the current gametype before warping to it.

SNAPTO <integer>

Sets a default height to place Things at with OBJECTPLACE. The possible values are: 0 = off; 1 = floor; 2 = ceiling; 3 = halfway (1/2 of sector height).

SND_CHANNELS <integer>

HELP flags: AUTOSAVE;ACTION

Sets the number of sound channels.

SONICCD <boolean>

SUPERSNEAKERS <integer>

HELP flags: NETVAR;CHEAT

Sets the availability of Super Sneakers in a game. 0 is off, 1 is low, 2 is medium (default) and 3 is high. Cheats must be enabled in order to change this. (Server or Game Admin only)

SURROUND <boolean>

HELP flags: AUTOSAVE

Toggles DirectSound3D acceleration.

TAGTYPE <integer>

HELP flags: NETVAR;ACTION

Sets the type of Tag mode. 0 is Tag, 1 is Hide and Seek. Beware: If this is used in mid-game to switch from H&S to Tag, the hiders will still not be able to move. (Server or Game Admin only)

TAILSPICKUP <boolean>

HELP flags: NETVAR

Allows flying characters to pick up another character. If it is off, players become solid and can stand on top of one another to form a ladder. (Server or Game Admin only)

TEAMSCRAMBLE <integer or type>

HELP flags: NETVAR;ACTION

Instantly scrambles all players to different teams in Team Match and CTF. Set it to 1 for a Random scramble or 2 to scramble by each individual player's Points. (0 has no effect.) Can also be done using the Scramble Teams option on the main menu, which does not appear in 2-player mode. (Server or Game Admin only)

TELEPORTERS <integer>

HELP flags: NETVAR;CHEAT

Sets the availability of Teleporters in a game. 0 is off, 1 is low, 2 is medium (default) and 3 is high. Cheats must be enabled in order to change this. (Server or Game Admin only)

TIMELIMIT <integer>

HELP flags: NETVAR;ACTION

Sets a time limit, in minutes, for multiplayer levels. The command TIMELIMIT 0 will disable the time limit. (Server or Game Admin only)

TIMETIC <off/on/full>

Makes the in-game timer count the number of tics (frames) instead of the number of seconds. Alternatively, if set to Full (2), it shows the centiseconds along with the regular timer.

TRANSLUCENCY <boolean>

HELP flags: AUTOSAVE

Turns sprite translucency on or off.

TOUCHTAG <boolean>

HELP flags: NETVAR

If enabled, the IT player(s) in Tag and Hide & Seek can tag the fleeing players simply by touching them. (Server or Game Admin only)

USE_JOYSTICK/USE_JOYSTICK2 <integer>

HELP flags: AUTOSAVE;ACTION

USE_MOUSE/USE_MOUSE2 <integer>

HELP flags: AUTOSAVE;ACTION

USERANALOG/USERANALOG2 <boolean>

HELP flags: AUTOSAVE;ACTION

Turns analog control on/off. Disabled in netgames. This variable should be used instead of ANALOG/ANALOG2.

VID_WAIT <boolean>

HELP flags: AUTOSAVE

Enables/Disables V-Sync.

VID_TICRATE <integer>

Shows game speed (frame rate) stats. 1 is in counter form, 2 is in graph form, and 3 is both.

VIEWHEIGHT <integer>

Changes the vertical offset of viewing. Ranges from 15 to 56. Default is 41.

WATERSHIELD <integer>

HELP flags: NETVAR;CHEAT

Sets the availability of Elemental Shields in a game. 0 is off, 1 is low, 2 is medium (default) and 3 is high. Cheats must be enabled in order to change this. (Server or Game Admin only)

Console

Contents

Syntax

Special Characters

Semicolon (;)

Quote (")

Script files

autoexec.cfg

adedserv.cfg

Commands

ADDFILE <filename>

ALIAS <commands>

BAN <playername/node> <reason>

BIND <key> <command>

CD <action>

CECHO <message>

CECHODURATION <seconds>

CECHOFLAGS <integer>

CHANGECONFIG <filename>

CHANGETEAM/CHANGETEAM2 <red/blue/spectator/playing>

CHARABILITY <1/2> <value>

CHARSPEED <parameter> <value>

CLEARBANS

CLEARSCORES

CLS

CONNECT <ip>

COUNTMOBJS

CSAY <message>

DEVMODE <integer>

DISPLAYPLAYER

ECHO <message>

ENGLISH

EXEC <filename>

EXITGAME

EXITLEVEL

GAMETYPE

GETALLEMERALDS

GETPLAYERNUM

GOD

GR_STATS

GRAVFLIP

HELP <command>

HURTME <value>

ISGAMEMODIFIED

JUMPTOAXIS <axis number>

KICK <playername/node> <reason>

LISTSERV

LISTWAD

LOADCONFIG <filename>

LOGIN <password>

MAP MAP<value>

-GAMETYPE <game mode name or number>

-FORCE

-NORESETPLAYERS

MOD_DETAILS

MEMFREE

MOTD <message>

NOCLIP

NODES

NUMTHINKERS <number>

ORDERPIZZA

PASSWORD <value>

PAUSE

PING <player/node>

PLAYDEMO <filename>

PLAYINTRO

QUIT

RELOADBANS

RESETCAMERA

RESETEMERALDS

RTELEPORT -x <X distance> -y <Y distance> -z <Z distance>

RUNSOC <socfile.soc or lumpname>

SAVECHECKPOINT

SAVECONFIG <filename>

SAY <message>

SAYTEAM <message>

SAYTO <playername/node> <message>

SCALE <percent>

SERVERCHANGETEAM <playername/node> <red/blue/spectator/playing/it/notit>

SCREENSHOT