266cc8908c5c6ac3f5715f60b338d06a5cf24094
[xonotic/xonotic-data.pk3dir.git] / commands.cfg
1 // =================================================================
2 //  Master config for managing various command aliases and settings
3 // =================================================================
4
5 // Execute commands based on whether it is dedicated a server or a client.
6 alias "_detect_dedicated_$qport" "${* asis}"
7 alias "_detect_dedicated_0" ""
8 alias _if_dedicated "_detect_dedicated_$qport ${* asis}"
9 alias if_client "${* asis}"
10 alias if_dedicated "${* asis}"
11 _if_dedicated alias if_client ""
12 if_client alias if_dedicated ""
13
14 // for easy access by QC
15 if_dedicated set is_dedicated 1
16 if_client    set is_dedicated 0
17
18 if_dedicated "alias" qc_cmd_sv     "sv_cmd $$*"
19 if_client    "alias" qc_cmd_sv     "sv_cmd $$*"
20 // if_client    "alias" qc_cmd_sv     "echo This command only works on servers: sv_cmd $${* !}"
21 if_dedicated "alias" qc_cmd_cl     "echo This command only works on clients: cl_cmd $${* !}"
22 if_client    "alias" qc_cmd_cl     "cl_cmd $$*"
23 if_dedicated "alias" qc_cmd_cmd    "echo This command only works on clients: cmd $${* !}"
24 if_client    "alias" qc_cmd_cmd    "cmd $$*"
25
26 if_dedicated "alias" qc_cmd_svmenu "sv_cmd $$*"
27 if_client    "alias" qc_cmd_svmenu "menu_cmd $$*"
28 if_dedicated "alias" qc_cmd_svcl   "sv_cmd $$*"
29 if_client    "alias" qc_cmd_svcl   "cl_cmd $$*"
30 if_dedicated "alias" qc_cmd_svcmd  "sv_cmd $$*"
31 if_client    "alias" qc_cmd_svcmd  "cmd $$*"
32
33 if_dedicated "alias" help "sv_cmd help"
34 if_client    "alias" help "cl_cmd help; cmd help"
35
36
37 // ========
38 //  common
39 // ========
40 // networked/server common commands
41 alias cvar_changes         "qc_cmd_svcmd  cvar_changes         ${* ?}" // Prints a list of all changed server cvars
42 alias cvar_purechanges     "qc_cmd_svcmd  cvar_purechanges     ${* ?}" // Prints a list of all changed gameplay cvars
43 alias info                 "qc_cmd_svcmd  info                 ${* ?}" // Request for unique server information set up by admin
44 alias ladder               "qc_cmd_svcmd  ladder               ${* ?}" // Get information about top players if supported
45 alias lsmaps               "qc_cmd_svcmd  lsmaps               ${* ?}" // List maps which can be used with the current game mode
46 alias printmaplist         "qc_cmd_svcmd  printmaplist         ${* ?}" // Display full server maplist reply
47 alias rankings             "qc_cmd_svcmd  rankings             ${* ?}" // Print information about rankings
48 alias records              "qc_cmd_svcmd  records              ${* ?}" // List top 10 records for the current map
49 alias teamstatus           "qc_cmd_svcmd  teamstatus           ${* ?}" // Show information about player and team scores
50 alias time                 "qc_cmd_svcmd  time                 ${* ?}" // Print different formats/readouts of time
51 alias timein               "qc_cmd_svcmd  timein               ${* ?}" // Resume the game from being paused with a timeout
52 alias timeout              "qc_cmd_svcmd  timeout              ${* ?}" // Call a timeout which pauses the game for certain amount of time unless unpaused
53 alias vote                 "qc_cmd_svcmd  vote                 ${* ?}" // Request an action to be voted upon by players
54 alias who                  "qc_cmd_svcmd  who                  ${* ?}" // Display detailed client information about all players
55
56 // generic commands (across all programs)
57 alias addtolist            "qc_cmd_svmenu addtolist            ${* ?}" // Add a string to a cvar
58 alias dumpcommands         "qc_cmd_svmenu dumpcommands         ${* ?}" // Dump all commands on the program to *_cmd_dump.txt
59 alias dumpnotifs           "qc_cmd_svcl   dumpnotifs           ${* ?}" // Dump all notifications into notifications_dump.txt
60 alias maplist              "qc_cmd_svmenu maplist              ${* ?}" // Automatic control of maplist
61 alias nextframe            "qc_cmd_svmenu nextframe            ${* ?}" // Execute the given command next frame of this VM
62 alias qc_curl              "qc_cmd_svmenu qc_curl              ${* ?}" // Queries a URL
63 alias removefromlist       "qc_cmd_svmenu removefromlist       ${* ?}" // Remove a string from a cvar
64 alias restartnotifs        "qc_cmd_svcl   restartnotifs        ${* ?}" // Re-initialize all notifications
65 alias rpn                  "qc_cmd_svmenu rpn                  ${* ?}" // RPN calculator
66 //alias settemp            "qc_cmd_svmenu settemp              ${* ?}" // Temporarily set a value to a cvar which is restored later
67 //alias settemp_restore    "qc_cmd_svmenu settemp_restore      ${* ?}" // Restore all cvars set by settemp command
68
69 // other aliases for common commands
70 alias g_hitplots_add "qc_cmd_svmenu rpn /g_hitplots_individuals g_hitplots_individuals ${1 !} union def"
71 alias g_hitplots_remove "qc_cmd_svmenu rpn /g_hitplots_individuals g_hitplots_individuals ${1 !} difference def"
72
73 alias g_maplist_add     "qc_cmd_svmenu maplist add ${* ?}"
74 alias g_maplist_remove  "qc_cmd_svmenu maplist remove ${* ?}"
75 alias g_maplist_putfirst        "qc_cmd_svmenu maplist remove ${* ?} ; qc_cmd maplist add ${* ?}"
76 alias g_maplist_shufflenow      "qc_cmd_svmenu maplist shuffle"
77 alias g_maplist_cleanup "qc_cmd_svmenu maplist cleanup" // removes maps that don't exist from the map list
78
79 alias addfav "qc_cmd_svmenu addtolist net_slist_favorites ${* ?}"
80 alias addvote "qc_cmd_svmenu addtolist sv_vote_commands ${* ?}"
81
82
83 // ========================
84 //  engine command aliases
85 // ========================
86 alias bsp "ls maps/*.bsp"
87 alias chmap "changelevel ${* ?}"
88 alias clearmap "disconnect"
89 alias devmap "set _developer_save $developer; set developer 1; changelevel ${* ?}; set developer $_developer_save"
90 alias ply "playdemo $1"
91 alias rec "record demos/${1 !}"
92 alias search "apropos ${* ?}"
93 alias sv_loadconfig "exec $serverconfig"
94 alias sv_restart "say \"Server will restart at the end of the match, you will all be reconnected automatically. ${* ?} \"; quit_and_redirect self"
95 alias tdem "timedemo $1"
96
97
98 // ===============================================
99 //  menu_cmd (menu command) - menu/command/menu_cmd.qc
100 // ===============================================
101 alias menu_showteamselect "menu_cmd directmenu TeamSelect"
102 alias menu_showhudexit "menu_cmd directmenu HUDExit"
103 alias menu_showhudoptions "menu_cmd directpanelhudmenu ${* ?}"
104 alias menu_showsandboxtools "menu_cmd directmenu SandboxTools"
105 alias menu_showquitdialog "menu_cmd directmenu Quit"
106 alias menu_showmonstertools "menu_cmd directmenu MonsterTools"
107
108 // command executed before loading a map by the menu
109 // makes sure maxplayers is at least minplayers or bot_number + 1
110 alias _menu_loadmap_prepare_maxpl "maxplayers $_menu_loadmap_maxplayers"
111 alias menu_loadmap_prepare "disconnect; wait; g_campaign 0; menu_cmd rpn /_menu_loadmap_maxplayers menu_maxplayers minplayers bot_number 1 add max max def; _menu_loadmap_prepare_maxpl; g_maplist_shufflenow"
112
113
114 // ==========================================================
115 //  cl_cmd (client local command) - client/command/cl_cmd.qc
116 // ==========================================================
117 // commented out commands are really only intended for internal use
118 alias blurtest             "qc_cmd_cl     blurtest             ${* ?}" // Feature for testing blur postprocessing
119 alias create_scrshot_ent   "qc_cmd_cl     create_scrshot_ent   ${* ?}" // Create an entity at this location for automatic screenshots
120 alias debugmodel           "qc_cmd_cl     debugmodel           ${* ?}" // Spawn a debug model manually
121 //alias handlevote         "qc_cmd_cl     handlevote           ${* ?}" // System to handle selecting a vote or option
122 alias hud                  "qc_cmd_cl     hud                  ${* ?}" // Commands regarding/controlling the HUD system
123 alias localprint           "qc_cmd_cl     localprint           ${* ?}" // Create your own centerprint sent to yourself
124 //alias mv_download        "qc_cmd_cl     mv_download          ${* ?}" // Retrieve mapshot picture from the server
125 alias sendcvar             "qc_cmd_cl     sendcvar             ${* ?}" // Send a cvar to the server (like weaponpriority)
126 alias exit                 "quit"
127
128 // other aliases for local commands
129 alias hud_configure "qc_cmd_cl hud configure"
130 alias hud_save "qc_cmd_cl hud save ${* ?}"
131 alias radar "qc_cmd_cl hud radar ${* ?}"
132 alias scoreboard_columns_help "qc_cmd_cl hud scoreboard_columns_help"
133 alias scoreboard_columns_set "qc_cmd_cl hud scoreboard_columns_set ${* ?}"
134
135 // changes a cvar and reports it to the server (for the client to notify the server about changes)
136 alias setreport "set \"$1\" \"$2\" ; sendcvar \"$1\""
137
138
139 // ========================================================
140 //  cmd (client-to-server command) - server/command/cmd.qc
141 // ========================================================
142 set sv_clientcommand_antispam_time 1 "Amount of seconds after a command before another command can be called again without being considered spam. (Use -1 for no antispam limit)"
143 set sv_clientcommand_antispam_count 8 "Amount of commands considered spam before commands are rejected."
144 seta sv_status_privacy 1 "hide IP addresses from \"status\" and \"who\" replies shown to clients"
145 seta cl_autoswitch 1 "automatically switch to newly picked up weapons if they are better than what you are carrying"
146
147 // commented out commands are really only intended for internal use, or already have declaration in the engine
148 alias autoswitch           "qc_cmd_cmd    autoswitch           ${* ?}" // Whether or not to switch automatically when getting a better weapon
149 alias checkfail            "qc_cmd_cmd    checkfail            ${* ?}" // Report if a client-side check failed
150 alias clientversion        "qc_cmd_cmd    clientversion        ${* ?}" // Release version of the game
151 //alias mv_getpicture      "qc_cmd_cmd    mv_getpicture        ${* ?}" // Retrieve mapshot picture from the server
152 alias join                 "qc_cmd_cmd    join                 ${* ?}" // Become a player in the game
153 alias ready                "qc_cmd_cmd    ready                ${* ?}" // Qualify as ready to end warmup stage (or restart server if allowed)
154 alias reportcvar           "qc_cmd_cmd    reportcvar           ${* ?}" // Old system for sending a client cvar to the server
155 //alias say                "qc_cmd_cmd    say                  ${* ?}" // Print a message to chat to all players
156 //alias say_team           "qc_cmd_cmd    say_team             ${* ?}" // Print a message to chat to all team mates
157 alias selectteam           "qc_cmd_cmd    selectteam           ${* ?}" // Attempt to choose a team to join into
158 alias selfstuff            "qc_cmd_cmd    selfstuff            ${* ?}" // Stuffcmd a command to your own client
159 alias sentcvar             "qc_cmd_cmd    sentcvar             ${* ?}" // New system for sending a client cvar to the server
160 alias editmob              "qc_cmd_cmd    mobedit              ${* ?}" // Edit a monster's properties
161 alias killmob              "qc_cmd_cmd    mobkill              ${* ?}" // Kill a monster
162 alias spawnmob             "qc_cmd_cmd    mobspawn             ${* ?}" // Spawn a monster infront of the player
163 alias spectate             "qc_cmd_cmd    spectate             ${* ?}" // Become an observer
164 alias suggestmap           "qc_cmd_cmd    suggestmap           ${* ?}" // Suggest a map to the mapvote at match end
165 //alias tell               "qc_cmd_cmd    tell                 ${* ?}" // Send a message directly to a player
166 alias voice                "qc_cmd_cmd    voice                ${* ?}" // Send voice message via sound
167
168 // other aliases for client-to-server commands
169 alias autoswitch "set cl_autoswitch ${1 ?} ; cmd autoswitch ${1 ?}" // todo
170
171 alias team_red "cmd selectteam red; cmd join"
172 alias team_blue "cmd selectteam blue; cmd join"
173 alias team_pink "cmd selectteam pink; cmd join"
174 alias team_yellow "cmd selectteam yellow; cmd join"
175 alias team_auto "cmd selectteam auto; cmd join"
176
177 alias spec "spectate"
178
179 // mutator aliases
180 alias sandbox "cmd g_sandbox ${* ?}"
181
182
183 // ============================================================
184 //  sv_cmd (server console command) - server/command/sv_cmd.qc
185 // ============================================================
186 alias adminmsg             "qc_cmd_sv     adminmsg             ${* ?}" // Send an admin message to a client directly
187 alias allready             "qc_cmd_sv     allready             ${* ?}" // Restart the server and reset the players
188 alias allspec              "qc_cmd_sv     allspec              ${* ?}" // Force all players to spectate
189 alias anticheat            "qc_cmd_sv     anticheat            ${* ?}" // Create an anticheat report for a client
190 alias bbox                 "qc_cmd_sv     bbox                 ${* ?}" // Print detailed information about world size
191 alias bot_cmd              "qc_cmd_sv     bot_cmd              ${* ?}" // Control and send commands to bots
192 alias butcher              "qc_cmd_sv     butcher              ${* ?}" // Remove all monsters on the map
193 alias cointoss             "qc_cmd_sv     cointoss             ${* ?}" // Flip a virtual coin and give random result
194 alias database             "qc_cmd_sv     database             ${* ?}" // Extra controls of the serverprogs database
195 alias defer_clear          "qc_cmd_sv     defer_clear          ${* ?}" // Clear all queued defer commands for a specific client
196 alias defer_clear_all      "qc_cmd_sv     defer_clear_all      ${* ?}" // Clear all queued defer commands for all clients
197 alias delrec               "qc_cmd_sv     delrec               ${* ?}" // Delete race time record for a map
198 alias effectindexdump      "qc_cmd_sv     effectindexdump      ${* ?}" // Dump list of effects from code and effectinfo.txt
199 alias extendmatchtime      "qc_cmd_sv     extendmatchtime      ${* ?}" // Increase the timelimit value incrementally
200 alias find                 "qc_cmd_sv     find                 ${* ?}" // Search through entities for matching classname
201 alias gametype             "qc_cmd_sv     gametype             ${* ?}" // Simple command to change the active gametype
202 alias gettaginfo           "qc_cmd_sv     gettaginfo           ${* ?}" // Get specific information about a weapon model
203 alias gotomap              "qc_cmd_sv     gotomap              ${* ?}" // Simple command to switch to another map
204 alias lockteams            "qc_cmd_sv     lockteams            ${* ?}" // Disable the ability for players to switch or enter teams
205 alias make_mapinfo         "qc_cmd_sv     make_mapinfo         ${* ?}" // Automatically rebuild mapinfo files
206 alias moveplayer           "qc_cmd_sv     moveplayer           ${* ?}" // Change the team/status of a player
207 alias nospectators         "qc_cmd_sv     nospectators         ${* ?}" // Automatically remove spectators from a match
208 alias playerdemo           "qc_cmd_sv     playerdemo           ${* ?}" // Control the ability to save demos of players
209 alias printstats           "qc_cmd_sv     printstats           ${* ?}" // Dump eventlog player stats and other score information
210 alias radarmap             "qc_cmd_sv     radarmap             ${* ?}" // Generate a radar image of the map
211 alias reducematchtime      "qc_cmd_sv     reducematchtime      ${* ?}" // Decrease the timelimit value incrementally
212 alias setbots              "qc_cmd_sv     setbots              ${* ?}" // Adjust how many bots are in the match
213 alias shuffleteams         "qc_cmd_sv     shuffleteams         ${* ?}" // Randomly move players to different teams
214 alias stuffto              "qc_cmd_sv     stuffto              ${* ?}" // Send a command to be executed on a client
215 alias trace                "qc_cmd_sv     trace                ${* ?}" // Various debugging tools with tracing
216 alias unlockteams          "qc_cmd_sv     unlockteams          ${* ?}" // Enable the ability for players to switch or enter teams
217 alias warp                 "qc_cmd_sv     warp                 ${* ?}" // Choose different level in campaign
218
219 // other aliases for server commands
220 alias endmatch "timelimit -1"
221
222 alias savedb "sv_cmd database save \"${1 ?}\""
223 alias dumpdb "sv_cmd database dump \"${1 ?}\""
224 alias loaddb "sv_cmd database load \"${1 ?}\""
225
226 alias movetored "moveplayer ${1 ?} red"
227 alias movetoblue "moveplayer ${1 ?} blue"
228 alias movetopink "moveplayer ${1 ?} pink"
229 alias movetoyellow "moveplayer ${1 ?} yellow"
230 alias movetoauto "moveplayer ${1 ?} auto"
231
232
233 // =======================================================
234 //  Aliases for settemp subsystem. Warning: Do not touch.
235 //  Usage: settemp variable value, next map resets it.
236 // =======================================================
237 alias settemp "qc_cmd_svcl settemp $*"
238 alias settemp_restore "qc_cmd_svcl settemp_restore"
239
240
241 // ===================================
242 //  banning - server/command/ipban.qc
243 // ===================================
244 alias ban                  "qc_cmd_sv     ban                  ${* ?}" // Ban an IP address or a range of addresses (like 1.2.3)
245 alias banlist              "qc_cmd_sv     banlist              ${* ?}" // List all existing bans
246 alias kickban              "qc_cmd_sv     kickban              ${* ?}" // Disconnect a client and ban it at the same time
247 alias mute                 "qc_cmd_sv     mute                 ${* ?}" // Disallow a client from talking by muting them
248 alias unban                "qc_cmd_sv     unban                ${* ?}" // Remove an existing ban
249 alias unmute               "qc_cmd_sv     unmute               ${* ?}" // Unmute a client
250
251 // other aliases for ban commands
252 alias bans "banlist"
253
254 // character classes (intersected with 32..126 minus ", $, ;, ^, \ - if you
255 // want these, include them explicitly)
256 // note that QC code always forbids $ and ; in VoteCommand_checknasty
257 set _iscntrl ""
258 set _isblank " "
259 set _ispunct "!#%&'()*+,-./:<=>?@[]_`{|}~"
260 set _isdigit "0123456789"
261 set _isupper "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
262 set _islower "abcdefghijklmnopqrstuvwxyz"
263 set _isxdigit "0123456789abcdefABCDEF"
264
265 // derived character classes
266 set _isalpha "$_isupper$_islower"
267 set _isalnum "$_isalpha$_isdigit"
268 set _isgraph "$_ispunct$_isalnum"
269 set _isascii "$_isgraph$_isblank"
270 set _isprint "$_isgraph$_isblank"
271 set _isspace "$_isblank"
272
273 // restriction is specified as <minargs> followed by <maxargs> instances of ';'
274 // and the optional character class to verify the argument by (no checking if
275 // empty)
276 // set cvar to empty string to not check the command at all
277 // if cvar is not set there will be a warning
278 set sv_vote_command_restriction_restart "0"
279 set sv_vote_command_restriction_fraglimit "1;$_isdigit"
280 set sv_vote_command_restriction_chmap "1;$_isgraph"
281 set sv_vote_command_restriction_gotomap "1;$_isgraph"
282 set sv_vote_command_restriction_nextmap "1;$_isgraph"
283 set sv_vote_command_restriction_endmatch "0"
284 set sv_vote_command_restriction_reducematchtime "0"
285 set sv_vote_command_restriction_extendmatchtime "0"
286 set sv_vote_command_restriction_allready "0"
287 set sv_vote_command_restriction_kick "1;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;" // enough space for ban reason
288 set sv_vote_command_restriction_kickban "1;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;" // enough space for ban reason
289 set sv_vote_command_restriction_cointoss "0"
290 set sv_vote_command_restriction_movetoauto "1;"
291 set sv_vote_command_restriction_movetored "1;"
292 set sv_vote_command_restriction_movetoblue "1;"
293 set sv_vote_command_restriction_movetoyellow "1;"
294 set sv_vote_command_restriction_movetopink "1;"
295
296 // =================================
297 //  voting - server/command/vote.qc
298 // =================================
299 set sv_vote_call 1 "Allow users to call a vote for the commands in sv_vote_commands"
300 set sv_vote_change 1 "Allow voters to change their mind after already voting"
301 set sv_vote_commands "restart fraglimit chmap gotomap nextmap endmatch reducematchtime extendmatchtime allready kick cointoss movetoauto shuffleteams" "these commands can be voted"
302 set sv_vote_only_commands ""
303 set sv_vote_limit 160 "Maximum allowed length of a vote command"
304 set sv_vote_master_commands "movetored movetoblue movetoyellow movetopink" "Extra commands which vote masters can execute by themselves, along with the normal sv_vote_commands." // maybe add kickban here (but then sv_vote_master 0)
305 set sv_vote_master 1    "Allows the use of the vote master system"
306 set sv_vote_master_callable 1 "When set, users can use \"vmaster\" to call a vote to become master of voting commands"
307 set sv_vote_master_password "" "when set, users can use \"vlogin PASSWORD\" to log in as master"
308 set sv_vote_master_playerlimit 2 "Minimum number of players needed for a player to be allowed to vote for master"
309 set sv_vote_no_stops_vote 1 "Allow the vote caller to stop his own vote simply by voting no"
310 set sv_vote_singlecount 0       "set to 1 to count votes once after timeout or to 0 to count with every vote"
311 set sv_vote_timeout 30  "a vote will timeout after this many seconds"
312 set sv_vote_wait 120    "a player can not call a vote again for this many seconds when his vote was not accepted"
313 set sv_vote_stop 15     "a player can not call a vote again for this many seconds when he stopped this vote (e.g. to correct it)"
314 set sv_vote_majority_factor 0.5 "What percentage of the PLAYERS constitute a majority? (Must be at least 0.5, recommended: 0.5)"
315 set sv_vote_majority_factor_of_voted 0.5 "What percentage of the VOTERS constitute a majority too? (Must be at least 0.5, recommended: 0.5)"
316 set sv_vote_gamestart 0 "Allow voting during map change"
317 // when disabled, don't allow game type changes "note: set these two equal to JUST support simple majorities"
318 set sv_vote_override_mostrecent 0
319
320 // aliases for client only
321 alias vmaster   "qc_cmd_cmd vote master"
322 alias vlogin    "qc_cmd_cmd vote master login ${* ?}"
323 alias vdo       "qc_cmd_cmd vote master do ${* ?}"
324 alias vyes      "qc_cmd_cl handlevote yes"
325 alias vno       "qc_cmd_cl handlevote no"
326 alias vdontcare "qc_cmd_cmd vote abstain"
327 alias vabstain  "qc_cmd_cmd vote abstain"
328
329 // aliases for both client and server
330 alias vcall     "qc_cmd_svcmd vote call ${* ?}"
331 alias vhelp     "qc_cmd_svcmd vote help"
332 alias vstatus   "qc_cmd_svcmd vote status"
333 alias vstop     "qc_cmd_svcmd vote stop"
334
335 // general
336 alias vmap "vcall gotomap ${1 ?}"
337 alias vnextmap "vcall nextmap ${1 ?}"
338 alias vkick "vcall kick ${1 ?}"
339 alias vkickban "vcall kickban ${1 ?}"
340 alias vend "vcall endmatch"
341 alias vdomap "vdo gotomap ${1 ?}"
342 alias vdokick "vdo kick ${* ?}"
343 alias vdokickban "vdo kickban ${* ?}"
344 alias vdoend "vdo endmatch"
345 alias vext "vcall extendmatchtime"
346
347 // ======================
348 //  rcon server commands
349 // ======================
350 rcon_secure 1
351 set rcon_restricted_commands "restart fraglimit chmap gotomap endmatch reducematchtime extendmatchtime allready kick kickban \"sv_cmd bans\" \"sv_cmd unban *\" status \"sv_cmd teamstatus\" movetoauto movetored movetoblue movetoyellow movetopink"