Console commands

From Zandronum Wiki
Revision as of 20:22, 12 December 2021 by DrinkyBird (talk | contribs) (3.1 is released, so Devfeature templates have been removed)

Commands is very useful to control the game settings and available settings. Every setting can be controlled by either commands or Console_Variables, this allows users and server administrators greater flexibility of control. Additionally, commands can be entered via console from either the server console, RCon utility, or the clients individually. Clients can enter commands by using the console by pressing the (~) key (US English Keyboards); Furthermore, clients can also control the servers via RCon control, but the clients must have the correct RCon password in order to use this permission.


Zandronum Console Commands
Updated to: Zandronum 1.1.1 - Revision: 130718-2050
Command Client or Server Description
AddBan

AddBan 192.168.2.* 2min "Test Ban"

Server Issues a ban on an individual client or clients. Syntax for AddBan is: AddBan <IPv4>
AddBanExemption

AddBanExemption 192.168.2.50

Server Allows clients that are caught in a range ban to be omitted from the ban. Additionally, the clients IP will be added into the whitelist. However, if the clients IP changes, their new issued IP must be added into the whitelist.
AddBot

AddBot "Strife Guy"

Both Allows the possibility to add a bot into the game. Bots can be added just by random (AddBot) or use a specific bot (AddBot "BotName"). Zandronums's bot compatibility is different compared to ZDoom's bot compatibility, for example, the bots movement compared the two are different along with the bots response. However, these bots are only usable for deathmatch related game modes with no support for Team based games and cooperative games.
AddMap

AddMap MAP02

AddMap MAP02 2 10

Server When using 'SV_MapRotation', AddMap can be used to define what maps to include into the map list.

AddMap also supports optional minimum and maximum player limits.

Ban

Ban JoeDirt Perm "Test"

Server Adds the clients IP to the blacklist. Syntax for Ban is: Ban <PlayerName>
Ban_IDx

Ban_IDx 5 "45 Months" "test"

Server Bans a specific client by use of the Player index number list. Syntax for Ban_IDx is: Ban_IDx <Index integer>
Bind

Bind w +forward

Client Binds a specific key to do a certain Console Command.
CallVote

CallVote ChangeMap MAP23 "Reason"

Client When used with an argument, allows the user to call a vote and allowing all clients within the server to cast their votes.
CallVote [ARGUMENT] [VALUE or MAP] (Reason)
Argument Information
Kick Kicks a player from the server.
ForceSpec If passed, forces the Player call upon to Spec
Map Changes the map without the intermission screen.
  • Maps that are not specified to the servers map rotation list are not available.
ChangeMap Changes the map with an intermission screen.
  • Maps that are not specified to the servers map rotation list are not available.
NextMap Changes to the next map. If the map rotation is enabled, this will go to the next map in rotation; otherwise it proceeds to the nextmap defined in the current map's MAPINFO.
NextSecret Changes to the secret map, if the current map has a nextsecret defined in its MAPINFO. Otherwise, this behaves like a normal nextmap vote.
FragLimit Changes the FragLimit integer value.
TimeLimit Changes the TimeLimit integer value.
WinLimit Changes the WinLimit integer value.
DuelLimit Changes the DuelLimit integer value.
PointLimit Changes the PointLimit integer value.
Flag Changes whether the given DMFlag is enabled. The vote type to use when changing a flag is the console variable of that flag.
CancelVote Both Forces the vote to be terminated.
ChangeMap

ChangeMap MAP31 or ChangeMap K1E1

Both This CCMD allows the server to switch to another specified map. As this CCMD is adjacent to 'Map' CCMD, ChaneMap will not force the clients to reconnect back to the server, but the clients will go into the intermission screen instead. When using this CCMD, be sure to use the 'Map LUMP Name' and not the name of the level. For example, do not use 'ChangeMap "The Entryway", but instead use 'ChangeMap MAP01'. If this CCMD is used within the server, all clients are forced to automatically reconnect to the server. Furthermore, if the client uses this CCMD while on the server, the client will disconnect from the server and start a new single player game.
  • Note: For specialized PWAD and compressed files, please be sure to check the .txt file that is included with the file. The raw text document should and usually contains the map ranges used, as not all projects use the standard 'MAPx' format. For example, DIP01-08.
ChangeMus

ChangeMus "D_RUNNIN" or ChangeMus "http://somedomain.lol:1234/music.ogg"

Client This CCMD allows the music to be changed. The music 'Lump name' must be known in order to switch to a specific music file. Audio streams are also valid (ie: ogg/mp3). The 'address/location' of the stream is entered instead of the 'Lump name'.
ChangeTeam

ChangeTeam

Client When used, allows the player to change to the opposite team or prompted on which team to switch too. Of course, only used on team based game modes.
Clear Client Flushes all of the messages from the console.
ClearBans Server Expunges all of the clients IP's from the blacklist.
ClearMapList Server Thrashes all maps from the server's MapList.
CMDList Both Displays all available Commands on the console.
Connect

Connect 127.0.0.1:10666

Client Allows the clients to connect to the server remotely. However, clients must have the same exact PWAD(s) loaded with Zandronum that is also on the server. If not, clients will receive an authentication error.
CountActors Client This CCMD displays how many of each actors are present within the map, and displays how many have a 'network id'.
Crouch Client The player goes into a crouch state.
CVarList Client Displays all available Console Variables on the console.
CVarListPlain Client Displays all of the Console Variables and their current values from the clients settings.
DelBan

DelBan 127.0.0.1

Server Expunges the specified IP from the blacklist.
DelBanExemption

DelBanExemption 192.168.0.50

Server Expunges the specified IP from the whitelist.
DelMap Server Removes a map by lump name from rotation.
DelMap_IDx Server Removes a map by number from rotation.
Demo_SkipTics Client Skip to a further point in a demo. 'Demo_SkipTics 35' will skip one second ahead.
Demo_SkipToNextMap Client When playing a client side demo, this command jumps the playback to the next map change.
Demo_SpectateFreely Client In this mode, you can move freely while the demo is played as if you were a spectator while the game was recorded.
Disconnect Client Client will disconnect from the server, but the executable will continue.
Drop

Drop Pistol

Client Drops an item from the players inventory.
DumpStates Client Debugging
DumpTrafficMeasure Server Displays how much of the bandwidth is used for both ACS scripts and Actor classes. However, the server CVar SV_MeasureOutBoundTraffic must be true for this to work. See Measuring outbound traffic for a tutorial.
EndGame Client When used on a Single Player game, the game will end and the screen will restore back to the Doom (or other IWAD) welcome screen.
Exit Both Terminates the current Zandronum session.
GameVersion Both Displays the current executable version and revision.
GetIP

GetIP "Player"

Server When used within the server console, this CCMD displays the targeted clients IP address.
GetIP_IDx

GetIP_IDx 6

Server When used within the server console, this CCMD displays the targeted clients IP address by use of the Player index number list. The player index number list can be found in the 'PlayerInfo' CCMD.
History Both When used, this displays all of the commands that were inputted into the console.
IDChoppers Client Enables the 'IDChoppers' cheat (Original Doom cheat).
IDClev Client Enables the 'IDClev' cheat (Original Doom cheat).
IDFA Client Enables the 'IDFA' cheat (Original Doom cheat).
IDDQD Client Enables the 'IDDQD' cheat (Original Doom cheat).
IDKFA Client Enables the 'IDKFA' cheat (Original Doom cheat).
IDMUS Client Enables the 'IDMUS' cheat (Original Doom cheat).
Ignore

Ignore "Mr. X"

Both Ignores a specified client. It is plausible to specify a time in which the client is ignored, such as Ignore "Mr. X" 5. The time is measured in minutes.
Ignore_IDx

Ignore_IDx 4

Both Ignores a specific client with the use of Player Index number list. It is plausible to specify a time in which the client is ignored, such as Ignore_IDx 4 5. The player index number list can be found in the 'PlayerInfo' CCMD.
InsertMap <Lump name> <Position> [MinPlayers] [MaxPlayers]

InsertMap MAP32 5

Server Inserts a map to the map rotation list, after [Position]. Use CCMD maplist to list the rotation with index numbers.

InsertMap also supports optional minimum and maximum player limits.

InvDrop

InvDrop "RedKey"

Client This CCMD allows the clients to drop inventory items, such as ammunition.
InvQuery Client <From Zdoom Wiki> Prints to the console the name (Tag or class name) of the currently selected item, as well as its amount in the inventory.
InvUse Client Forces the client to use an artifact or item that is selected within the inventory.
IP Both Displays the clients IP on the console.
Join Client When used, this allows the client to join in the game.
Kick

Kick "Player Name Here"

Server Forces the client to disconnect from the server. When using this CCMD use quotations on the players name in order to be sure that the correct player is kicked.
Kick_IDx

Kick_IDx 8

Server Forces the client to disconnect from the server, while utilizing the Player Index list.
Kick_IP

Kick_IP 127.0.0.1 "Reason"

Server Forces the client(s) with the exact IP address to be disconnected from the server. However, the clients can reconnect to the server.
KickFromGame

KickFromGame "Player 123"

Server Forces the client from the server to spectate the game. However, the client can rejoin the game when plausible.
KickFromGame_IDx

KickFromGame_IDx 13

Server Forces the client from the server to spectate the game by using the Player list index. However, the client can rejoin the game when plausible. The player index number list can be found in the 'PlayerInfo' CCMD.
Kill Client Kills the player.
ListBots Both Displays all available bots.
LogFile

LogFile "C:\Program Files(x86)\Zandronum\Log History\My First Log File.txt"

Both When used, this CCMD will log every messages presented within the console.
Map

Map MAP23 or Map WTF02

Both This CCMD allows the client or server to switch from on map to another, but without displaying an intermission screen. When using this CCMD, be sure to use the 'Map LUMP Name' and not the name of the level. For example, do not use 'Map "The Entryway", but instead use 'Map MAP01'. If this CCMD is used within the server, all clients are forced to automatically reconnect to the server. Furthermore, if the client uses this CCMD while on the server, the client will disconnect from the server and start a new single player game.
  • Note: For specialized PWAD and compressed files, please be sure to check the .txt file that is included with the file. The raw text document should and usually contains the map ranges used, as not all projects use the standard 'MAPx' format. For example, DIP01-08.
MapList Server Displays the servers MapList.
MotD Client Redisplays the 'Message of the Day' from the server.
Multiplayer Client When used, this emulates the settings if on the server.
NetGame Client When used, this emulates the settings if on the server.
NetState Client Displays the current game state, this can either by Single Player or NetGame.
NextMap Both When used, allows the server to jump into the next map. Adjacent to 'ChangeMap' and 'Map' CCMDs, but 'NextMap' does not require map names. NextMap will only advance to the next map that is specified in either MAPINFO or the MapRotation list.
NextSecret Both When used, this allows the server to jump into the next secret map.
Pause Client Pauses the Single Player game.
Pings Both Displays all of the connected clients pings.
PlayDemo

PlayDemo "MyDemo.cld"

Client Specifies what demo file to play.
PlayerInfo Both When entered by clients displays a Player index number list and their pings. However, when entered within the server console, this will display not only the Player index number list but their IP's.
PlayerSounds Client Displays all of the sound mappings on all player skins.
PrintJoinQueue Server This allows the server to list the full join queue.
Puke

Puke "SCRIPT #"

Both When used, allows the use to force a script to execute within the PWAD/PKx files. This is usually used for project developers.
Quit Both Terminates the current Zandronum session.
RCon

RCon [CVar or CCMD]

Client Allows the client to remotely control the server. But, however, the client must be authenticated to the server by using Send_Password CCMD.
Reconnect Client When used, the clients will reconnect to the previous connected server.
ReloadBans Server When used, this enforces the server to reload the blacklist. This is useful when the blacklist file has been modified and the server did not read the changes before the server initially started.
RemoveBot

RemoveBot "Strife Guy"

Both Removes either a random bot (RemoveBot) or removes a specific bot from the game (RemoveBot "BotName").
RemoveBots Both Remove all bots from the game.
Resurrect Client When a player dies in a singleplayer game, the client can be resurrected. This is similar to the 'Spawn where dead' DMFlag.
Say

Say "Hello World!"

Both Allows the players/server to communicate with others in the game, by use of the console.
Say_Team

Say_Team "Hello Team!"

Client Players within the team can communicate with each other and not publicly to other non-team players or the opposite team.
SayTo

SayTo "Player 123" "Hello!"

Both Allows the player/server to communicate privately with each other privately which other players cannot see, using the name of the player who will receive the message. If you want to send a private message to the server, use "Server" as the name instead.
SayTo_IDx

SayTo_IDx 2 "Hello!"

Both Allows the player/server to communicate privately with each other which other players cannot see, using the index of the player who will receive the message. If you want to send a private message to the server, use -1 for the index instead.
ScreenShot Client Takes a snapshot of whatever is displayed in the game.
Send_Password

Send_Password "AlBundy"

Client Sends a password to the server and grants access if the password is correct. Otherwise, if the password is not correct, the user will not gain control over the server.
SinglePlayer Client When used, this emulates the settings as playing in a singleplayer environment.
Spectate Client When used, this allows the player to roam around the map by flying. As a result, this allows the player to view the game without really playing it.
SpyCancel Client Restores the view back to the local player.
SpyCarrier Client While as a spectator or if allowed to spy on other players, the client can quickly spy on the player(s) who are carrying game mode items like flags, skulls, and terminator/possession artifacts. This is especially useful for streamers who may want to switch to whoever is carrying any of those items.
SpyNext Client While as a spectator or if allowed to spy on other players in teambased games also including cooperative game modes, the client can spy or view what the other player sees in 'Point of View'. SpyNext works on how players are ordered in 'PlayerInfo' list, next will work on an ascending order.
SpyPrev Client While as a spectator or if allowed to spy on other players in teambased games also including cooperative game modes, the client can spy or view what the other player sees in 'Point of View'. SpyPrev works on how players are ordered in 'PlayerInfo' list, 'Prev' or Previous will work on an descending order.
SpyTo

SpyTo "Player 123"

Client While as a spectator or if allowed to spy on other players in teambased games also including cooperative game modes, the client can quickly choose to spy or view what a specific player sees by entering their name.
SpyTo_IDx

SpyTo_IDx 1

Client While as a spectator or if allowed to spy on other players in teambased games also including cooperative game modes, the client can quickly choose to spy or view what a specific player sees by entering their index number.
Stat

Stat [Property]

Client Displays statistics for the following properties:
LightStats RenderStats RenderTimes SectorHacks
MissingTextures Sound Music SkyBoxes
Interpolations Blit Sight Spawns
Think GC ScanCycles WallCycles
FPS NetTraffic Bots Pathing
StopDemo Client When entered, Zandronum will immediately stop recording the demo file.
Taunt Client When used (usually by binds), this allows the player to taunt.
Team

Team Blue

Client Specifies which team the client will join.
Unignore

Unignore "Mr. X"

Both Unignores a specified client.
Unignore_IDx

Unignore_IDx 4

Both Unignores a specific client with the use of Player Index number list. The player index number list can be found in the 'PlayerInfo' CCMD.
Use [WEAPONNAME]

Use Shotgun

Client Forces the client to switch to the Shotgun weapon without scrolling.
Version_Info Both Displays information the Mercurial changeset that the binary build is based on.
Vid_FPS

Vid_FPS True

Client Displays the current FPS rate on the clients screen.
ViewBanList Server Displays the blacklist within the servers console
ViewBanExemptionList Server Displays the whitelist within the servers console.
WADS Both Displays all of the loaded WADs used in the current session.
WeapDrop Client Drops the current selected weapon.
WeapNext Client Switches to the next available weapon.
WeapPrev Client Switches to the previous weapon available.
WeapSwap Client Switches to the weapon that was used last.


Related Pages