no more nexuiz on home page
[xonotic/xonotic.wiki.git] / Commands.md
1 DarkPlaces Wiki
2 ===============
3
4 Console Commands
5 ================
6
7 !!**documentation needed**!! how to use console commands through console and alias commands
8
9     +attack : begin firing
10     +back : move backward
11     +button10 : activate button10 (behavior depends on mod)
12     +button11 : activate button11 (behavior depends on mod)
13     +button12 : activate button12 (behavior depends on mod)
14     +button13 : activate button13 (behavior depends on mod)
15     +button14 : activate button14 (behavior depends on mod)
16     +button15 : activate button15 (behavior depends on mod)
17     +button16 : activate button16 (behavior depends on mod)
18     +button3 : activate button3 (behavior depends on mod)
19     +button4 : activate button4 (behavior depends on mod)
20     +button5 : activate button5 (behavior depends on mod)
21     +button6 : activate button6 (behavior depends on mod)
22     +button7 : activate button7 (behavior depends on mod)
23     +button8 : activate button8 (behavior depends on mod)
24     +button9 : activate button9 (behavior depends on mod)
25     +forward : move forward
26     +jump : jump
27     +klook : activate keyboard looking mode, do not recenter view
28     +left : turn left
29     +lookdown : look downward
30     +lookup : look upward
31     +mlook : activate mouse looking mode, do not recenter view
32     +movedown : swim downward
33     +moveleft : strafe left
34     +moveright : strafe right
35     +moveup : swim upward
36     +right : turn right
37     +showscores : show scoreboard
38     +speed : activate run mode (faster movement and turning)
39     +strafe : activate strafing mode (move instead of turn)
40     +use : use something (may be used by some mods)
41     -attack : stop firing
42     -back : stop moving backward
43     -button10 : deactivate button10
44     -button11 : deactivate button11
45     -button12 : deactivate button12
46     -button13 : deactivate button13
47     -button14 : deactivate button14
48     -button15 : deactivate button15
49     -button16 : deactivate button16
50     -button3 : deactivate button3
51     -button4 : deactivate button4
52     -button5 : deactivate button5
53     -button6 : deactivate button6
54     -button7 : deactivate button7
55     -button8 : deactivate button8
56     -button9 : deactivate button9
57     -forward : stop moving forward
58     -jump : end jump (so you can jump again)
59     -klook : deactivate keyboard looking mode
60     -left : stop turning left
61     -lookdown : stop looking downward
62     -lookup : stop looking upward
63     -mlook : deactivate mouse looking mode
64     -movedown : stop swimming downward
65     -moveleft : stop strafing left
66     -moveright : stop strafing right
67     -moveup : stop swimming upward
68     -right : stop turning right
69     -showscores : hide scoreboard
70     -speed : deactivate run mode
71     -strafe : deactivate strafing mode
72     -use : stop using something
73     alias : create a script function (parameters are passed in as $X (being X a number), $* for all parameters, $X- for all parameters starting from $X). Without arguments show the list of all alias
74     apropos : lists all console variables/commands/aliases containing the specified string in the name or description
75     begin : signon 3 (client asks server to start sending entities, and will go to signon 4 (playing) when the first entity update is received)
76     bestweapon : send an impulse number to server to select the first usable weapon out of several (example: 8 7 6 5 4 3 2 1)
77     bf : briefly flashes a bright color tint on view (used when items are picked up); optionally takes R G B [A [alphafade]] arguments to specify how the flash looks
78     bind : binds a command to the specified key in bindmap 0
79     bindlist : bindlist: displays bound keys for bindmap 0 bindmaps
80     bottomcolor : QW command to set bottom color without changing top color
81     cd : execute a CD drive command (cd on/off/reset/remap/close/play/loop/stop/pause/resume/eject/info) - use cd by itself for usage
82     centerview : gradually recenter view (stop looking up/down)
83     changelevel : change to another level, bringing along all connected clients
84     changing : sent by qw servers to tell client to wait for level change
85     cl_areastats : prints statistics on entity culling during collision traces
86     cl_begindownloads : used internally by darkplaces client while connecting (causes loading of models and sounds or triggers downloads for missing ones)
87     cl_cmd : calls the client QC function GameCommand with the supplied string as argument
88     cl_downloadbegin : (networking) informs client of download file information, client replies with sv_startsoundload to begin the transfer
89     cl_downloadfinished : signals that a download has finished and provides the client with file size and crc to check its integrity
90     cl_modelindexlist : list information on all models in the client modelindex
91     cl_particles_reloadeffects : reloads effectinfo.txt and maps/levelname_effectinfo.txt (where levelname is the current map)
92     cl_soundindexlist : list all sounds in the client soundindex
93     clear : clear console history
94     cmd : send a console commandline to the server (used by some mods)
95     cmdlist : lists all console commands beginning with the specified prefix or matching the specified wildcard pattern
96     color : change your player shirt and pants colors
97     commandmode : input a console command
98     condump : output console history to a file (see also log_file)
99     connect : connect to a server by IP address or hostname
100     cprint : print something at the screen center
101     curl : download data from an URL and add to search path
102     cvar_lockdefaults : stores the current values of all cvars into their default values, only used once during startup after parsing default.cfg
103     cvar_resettodefaults_all : sets all cvars to their locked default values
104     cvar_resettodefaults_nosaveonly : sets all non-saved cvars to their locked default values (variables that will not be saved to config.cfg)
105     cvar_resettodefaults_saveonly : sets all saved cvars to their locked default values (variables that will be saved to config.cfg)
106     cvarlist : lists all console variables beginning with the specified prefix or matching the specified wildcard pattern
107     defer : execute a command in the future
108     demos : restart looping demos defined by the last startdemos command
109     dir : list files in searchpath matching an * filename pattern, one per line
110     disconnect : disconnect from server (or disconnect all clients if running a server)
111     download : downloads a specified file from the server
112     echo : print a message to the console (useful in scripts)
113     entities : print information on network entities known to client
114     envmap : render a cubemap (skybox) of the current scene
115     exec : execute a script file
116     fixtrans : change alpha-zero pixels in an image file to sensible values, and write out a new TGA (warning: SLOW)
117     fly : fly mode (flight)
118     fog : set global fog parameters (density red green blue [alpha [mindist [maxdist [top [fadedepth]]]]])
119     fog_heighttexture : set global fog parameters (density red green blue alpha mindist maxdist top depth textures/mapname/fogheight.tga)
120     force_centerview : recenters view (stops looking up/down)
121     fs_rescan : rescans filesystem for new pack archives and any other changes
122     fullinfo : allows client to modify their userinfo
123     fullserverinfo : internal use only, sent by server to client to update client's local copy of serverinfo string
124     gamedir : changes active gamedir list (can take multiple arguments), not including base directory (example usage: gamedir ctf)
125     gecko_create : Create a gecko browser instance
126     gecko_destroy : Destroy a gecko browser instance
127     gecko_injecttext : Injects text into a browser
128     gecko_movecursor : Move the cursor to a certain position
129     gecko_navigate : Navigate a gecko browser to a URI
130     give : alter inventory
131     gl_texturemode : set texture filtering mode (GL_NEAREST, GL_LINEAR, GL_LINEAR_MIPMAP_LINEAR, etc); an additional argument 'force' forces the texture mode even in cases where it may not be appropriate
132     gl_vbostats : prints a list of all buffer objects (vertex data and triangle elements) and total video memory used by them
133     god : god mode (invulnerability)
134     heartbeat : send a heartbeat to the master server (updates your server information)
135     help : open the help menu
136     impulse : send an impulse number to server (select weapon, use item, etc)
137     in_bind : binds a command to the specified key in the selected bindmap
138     in_bindlist : bindlist: displays bound keys for all bindmaps, or the given bindmap
139     in_bindmap : selects active foreground and background (used only if a key is not bound in the foreground) bindmaps for typing
140     in_unbind : removes command on the specified key in the selected bindmap
141     infobar : display a text in the infobar (usage: infobar expiretime string)
142     iplog_list : lists names of players whose IP address begins with the supplied text (example: iplog_list 123.456.789)
143     joyadvancedupdate : applies current joyadv* cvar settings to the joystick driver
144     kick : kick a player off the server by number or name
145     kill : die instantly
146     load : load a saved game file
147     loadconfig : reset everything and reload configs
148     loadfont : loadfont function tganame loads a font; example: loadfont console gfx/veramono; loadfont without arguments lists the available functions
149     loadsky : load a skybox by basename (for example loadsky mtnsun_ loads mtnsun_ft.tga and so on)
150     locs_add : add a point or box location (usage: x y z[ x y z] "name", if two sets of xyz are supplied it is a box, otherwise point)
151     locs_clear : remove all loc points/boxes
152     locs_reload : reload .loc file for this map
153     locs_removenearest : remove the nearest point or box (note: you need to be very near a box to remove it)
154     locs_save : save .loc file for this map containing currently defined points and boxes
155     ls : list files in searchpath matching an * filename pattern, multiple per line
156     map : kick everyone off the server and start a new level
157     maps : list information about available maps
158     maxplayers : sets limit on how many players (or bots) may be connected to the server at once
159     memlist : prints memory pool information (or if used as memlist 5 lists individual allocations of 5K or larger, 0 lists all allocations)
160     memstats : prints memory system statistics
161     menu_cmd : calls the menu QC function GameCommand with the supplied string as argument
162     menu_credits : open the credits menu
163     menu_keys : open the key binding menu
164     menu_load : open the loadgame menu
165     menu_main : open the main menu
166     menu_mods : open the mods browser menu
167     menu_multiplayer : open the multiplayer menu
168     menu_options : open the options menu
169     menu_options_colorcontrol : open the color control menu
170     menu_options_effects : open the effects options menu
171     menu_options_graphics : open the graphics options menu
172     menu_quit : open the quit menu
173     menu_reset : open the reset to defaults menu
174     menu_restart : restart menu system (reloads menu.dat)
175     menu_save : open the savegame menu
176     menu_setup : open the player setup menu
177     menu_singleplayer : open the singleplayer menu
178     menu_transfusion_episode : open the transfusion episode select menu
179     menu_transfusion_skill : open the transfusion skill select menu
180     menu_video : open the video options menu
181     messagemode : input a chat message to say to everyone
182     messagemode2 : input a chat message to say to only your team
183     mod_generatelightmaps : rebuilds lighting on current worldmodel
184     modeldecompile : exports a model in several formats for editing purposes
185     modellist : prints a list of loaded models
186     modelprecache : load a model
187     name : change your player name
188     net_refresh : query dp master servers and refresh all server information
189     net_slist : query dp master servers and print all server information
190     net_slistqw : query qw master servers and print all server information
191     net_stats : print network statistics
192     nextul : sends next fragment of current upload buffer (screenshot for example)
193     noclip : noclip mode (flight without collisions, move through walls)
194     notarget : notarget mode (monsters do not see you)
195     packet : send a packet to the specified address:port containing a text string
196     path : print searchpath (game directories and archives)
197     pause : pause the game (if the server allows pausing)
198     pausedemo : pause demo playback (can also safely pause demo recording if using QUAKE, QUAKEDP or NEHAHRAMOVIE protocol, useful for making movies)
199     ping : print ping times of all players on the server
200     pingplreport : command sent by server containing client ping and packet loss values for scoreboard, triggered by pings command from client (not used by QW servers)
201     pings : command sent by clients to request updated ping and packetloss of players on scoreboard (originally from QW, but also used on NQ servers)
202     play : play a sound at your current location (not heard by anyone else)
203     play2 : play a sound globally throughout the level (not heard by anyone else)
204     playdemo : watch a demo file
205     playermodel : change your player model
206     playerskin : change your player skin number
207     playvideo : play a .dpv video file
208     playvol : play a sound at the specified volume level at your current location (not heard by anyone else)
209     pointfile : display point file produced by qbsp when a leak was detected in the map (a line leading through the leak hole, to an entity inside the level)
210     pqrcon : sends a command to a proquake server console (if your rcon_password matches the server's rcon_password), or to the address specified by rcon_address when not connected (again rcon_password must match the server's)
211     prespawn : signon 1 (client acknowledges that server information has been received)
212     prvm_callprofile : prints execution statistics about the most time consuming QuakeC calls from the engine in the selected VM (server, client, menu)
213     prvm_childprofile : prints execution statistics about the most used QuakeC functions in the selected VM (server, client, menu), sorted by time taken in function with child calls
214     prvm_edict : print all data about an entity number in the selected VM (server, client, menu)
215     prvm_edictcount : prints number of active entities in the selected VM (server, client, menu)
216     prvm_edictget : retrieves the value of a specified property of a specified entity in the selected VM (server, client menu) into a cvar or to the console
217     prvm_edicts : prints all data about all entities in the selected VM (server, client, menu)
218     prvm_edictset : changes value of a specified property of a specified entity in the selected VM (server, client, menu)
219     prvm_fields : prints usage statistics on properties (how many entities have non-zero values) in the selected VM (server, client, menu)
220     prvm_global : prints value of a specified global variable in the selected VM (server, client, menu)
221     prvm_globalget : retrieves the value of a specified global variable in the selected VM (server, client menu) into a cvar or to the console
222     prvm_globals : prints all global variables in the selected VM (server, client, menu)
223     prvm_globalset : sets value of a specified global variable in the selected VM (server, client, menu)
224     prvm_printfunction : prints a disassembly (QuakeC instructions) of the specified function in the selected VM (server, client, menu)
225     prvm_profile : prints execution statistics about the most used QuakeC functions in the selected VM (server, client, menu)
226     quit : quit the game
227     r_editlights_clear : removes all world lights (let there be darkness!)
228     r_editlights_copyinfo : store a copy of all properties (except origin) of the selected light
229     r_editlights_edit : changes a property on the selected light
230     r_editlights_editall : changes a property on ALL lights at once (tip: use radiusscale and colorscale to alter these properties)
231     r_editlights_help : prints documentation on console commands and variables in rtlight editing system
232     r_editlights_importlightentitiesfrommap : load lights from .ent file or map entities (ignoring .rtlights or .lights file)
233     r_editlights_importlightsfile : load lights from .lights file (ignoring .rtlights or .ent files and map entities)
234     r_editlights_pasteinfo : apply the stored properties onto the selected light (making it exactly identical except for origin)
235     r_editlights_reload : reloads rtlights file (or imports from .lights file or .ent file or the map itself)
236     r_editlights_remove : remove selected light
237     r_editlights_save : save .rtlights file for current level
238     r_editlights_spawn : creates a light with default properties (let there be light!)
239     r_editlights_togglecorona : toggle on/off the corona option on the selected light
240     r_editlights_toggleshadow : toggle on/off the shadow option on the selected light
241     r_glsl_dumpshader : dumps the engine internal default.glsl shader into glsl/default.glsl
242     r_glsl_restart : unloads GLSL shaders, they will then be reloaded as needed
243     r_listmaptextures : list all textures used by the current map
244     r_replacemaptexture : override a map texture for testing purposes
245     r_restart : restarts renderer
246     r_texturestats : print information about all loaded textures and some statistics
247     rate : change your network connection speed
248     rcon : sends a command to the server console (if your rcon_password matches the server's rcon_password), or to the address specified by rcon_address when not connected (again rcon_password must match the server's); note: if rcon_secure is set, client and server clocks must be synced e.g. via NTP
249     reconnect : reconnect to the last server you were on, or resets a quakeworld connection (do not use if currently playing on a netquake server)
250     record : record a demo
251     register_bestweapon : (for QC usage only) change weapon parameters to be used by bestweapon; stuffcmd this in ClientConnect
252     restart : restart current level
253     save : save the game to a file
254     saveconfig : save settings to config.cfg (or a specified filename) immediately (also automatic when quitting)
255     say : send a chat message to everyone on the server
256     say_team : send a chat message to your team on the server
257     screenshot : takes a screenshot of the next rendered frame
258     sendcvar : sends the value of a cvar to the server as a sentcvar command, for use by QuakeC
259     set : create or change the value of a console variable
260     seta : create or change the value of a console variable that will be saved to config.cfg
261     setinfo : modifies your userinfo
262     sizedown : decrease view size (decreases viewsize cvar)
263     sizeup : increase view size (increases viewsize cvar)
264     skins : downloads missing qw skins from server
265     snd_restart : restart sound system
266     snd_unloadallsounds : unload all sound files
267     soundinfo : print sound system information (such as channels and speed)
268     soundlist : list loaded sounds
269     spawn : signon 2 (client has sent player information, and is asking server to send scoreboard rankings)
270     srcon : sends a command to the server console (if your rcon_password matches the server's rcon_password), or to the address specified by rcon_address when not connected (again rcon_password must match the server's); this always works as if rcon_secure is set; note: client and server clocks must be synced e.g. via NTP
271     startdemos : start playing back the selected demos sequentially (used at end of startup script)
272     status : print server status information
273     stop : stop recording or playing a demo
274     stopdemo : stop playing or recording demo (like stop command) and return to looping demos
275     stopdownload : terminates a download
276     stopsound : silence
277     stopul : aborts current upload (screenshot for example)
278     stopvideo : stop playing a .dpv video file
279     stuffcmds : execute commandline parameters (must be present in quake.rc script)
280     sv_areastats : prints statistics on entity culling during collision traces
281     sv_cmd : calls the server QC function GameCommand with the supplied string as argument
282     sv_saveentfile : save map entities to .ent file (to allow external editing)
283     sv_startdownload : begins sending a file to the client (network protocol use only)
284     tell : send a chat message to only one person on the server
285     timedemo : play back a demo as fast as possible and save statistics to benchmark.log
286     timerefresh : turn quickly and print rendering statistcs
287     toggle : toggles a console variable's values (use for more info)
288     toggleconsole : opens or closes the console
289     togglemenu : opens or closes menu
290     topcolor : QW command to set top color without changing bottom color
291     unalias : remove an alias
292     unbind : removes a command on the specified key in bindmap 0
293     unbindall : removes all commands from all keys in all bindmaps (leaving only shift-escape and escape)
294     user : prints additional information about a player number or name on the scoreboard
295     users : prints additional information about all players on the scoreboard
296     v_cshift : sets tint color of view
297     version : print engine version
298     vid_restart : restarts video system (closes and reopens the window, restarts renderer)
299     viewframe : change animation frame of viewthing entity in current level
300     viewmodel : change model of viewthing entity in current level
301     viewnext : change to next animation frame of viewthing entity in current level
302     viewprev : change to previous animation frame of viewthing entity in current level
303     wait : make script execution wait for next rendered frame
304     which : accepts a file name as argument and reports where the file is taken from
305