mirror of
https://git.code.sf.net/p/quake/quakeforge
synced 2025-04-25 02:52:06 +00:00
add command docs and update cvar docs for qf-server and qf-client-x11 for
beta7. Others will be forthcoming.
This commit is contained in:
Bill Currie
parent
bcd28f5e77
commit
d5a81d94e4
4 changed files with 417 additions and 3 deletions
272
doc/qf-client-x11-cmd.txt
Normal file
272
doc/qf-client-x11-cmd.txt
Normal file
|
|
@ -0,0 +1,272 @@
|
|||
+attack :
|
||||
When active player is firing/using current weapon
|
||||
+back :
|
||||
When active the player is moving backwards
|
||||
+forward :
|
||||
When active the player is moving forward
|
||||
+jump :
|
||||
When active the player is jumping
|
||||
+klook :
|
||||
When active, +forward and +back perform +lookup and +lookdown
|
||||
+left :
|
||||
When active the player is turning left
|
||||
+lookdown :
|
||||
When active the player's view is looking down
|
||||
+lookup :
|
||||
When active the player's view is looking up
|
||||
+mlook :
|
||||
When active moving the mouse or joystick forwards and backwards performs +lookup and +lookdown
|
||||
+movedown :
|
||||
When active the player is swimming down in a liquid
|
||||
+moveleft :
|
||||
When active the player is strafing left
|
||||
+moveright :
|
||||
When active the player is strafing right
|
||||
+moveup :
|
||||
When active the player is swimming up in a liquid
|
||||
+right :
|
||||
When active the player is turning right
|
||||
+showscores :
|
||||
Display information on everyone playing
|
||||
+showteamscores :
|
||||
Display information for your team
|
||||
+speed :
|
||||
When active the player is running
|
||||
+strafe :
|
||||
When active, +left and +right function like +moveleft and +moveright
|
||||
+use :
|
||||
Non-functional. Left over command for opening doors and triggering switches
|
||||
-attack :
|
||||
When active player is not firing/using current weapon
|
||||
-back :
|
||||
When active the player is not moving backwards
|
||||
-forward :
|
||||
When active the player is not moving forward
|
||||
-jump :
|
||||
When active the player is not jumping
|
||||
-klook :
|
||||
When active, +forward and +back don't perform +lookup and +lookdown
|
||||
-left :
|
||||
When active the player is not turning left
|
||||
-lookdown :
|
||||
When active the player's view is not looking up
|
||||
-lookup :
|
||||
When active the player's view is not looking up
|
||||
-mlook :
|
||||
When active moving the mouse or joystick forwards and backwards doesn't perform +lookup and +lookdown
|
||||
-movedown :
|
||||
When active the player is not swimming down in a liquid
|
||||
-moveleft :
|
||||
When active the player is not strafing left
|
||||
-moveright :
|
||||
When active the player is not strafing right
|
||||
-moveup :
|
||||
When active the player is not swimming up in a liquid
|
||||
-right :
|
||||
When active the player is not turning right
|
||||
-showscores :
|
||||
Stop displaying information on everyone playing
|
||||
-showteamscores :
|
||||
Stop displaying information for your team
|
||||
-speed :
|
||||
When active the player is not running
|
||||
-strafe :
|
||||
When active, +left and +right stop functioning like +moveleft and +moveright
|
||||
-use :
|
||||
Non-functional. Left over command for opening doors and triggering switches
|
||||
alias :
|
||||
Used to create a reference to a command or list of commands.
|
||||
When used without parameters, displays all current aliases.
|
||||
Note: Enclose multiple commands within quotes and seperate each command with a semi-colon.
|
||||
allskins :
|
||||
Download all skins that are currently in use
|
||||
bf :
|
||||
Background flash, used when you pick up an item
|
||||
bind :
|
||||
Assign a command or a set of commands to a key.
|
||||
Note: To bind multiple commands to a key, enclose the commands in quotes and separate with semi-colons.
|
||||
To bind to non-printable keys, use the key name.
|
||||
Key Name List: Escape, F1-F12, pause, backspace, tab, semicolon, enter, shift, ctrl, alt, space, ins,
|
||||
home, pgup, del, end, pgdn, uparrow, downarrow, leftarrow, rightarrow, mouse1-mouse3, aux1-aux9, joy1-joy4,
|
||||
mwheelup, mwheeldown
|
||||
Special: The escape, and ~ (tilde) keys can only be bound from an external configuration file.
|
||||
cd :
|
||||
Control the CD player.
|
||||
Commands:
|
||||
eject - Eject the CD.
|
||||
info - Reports information on the CD.
|
||||
loop (track number) - Loops the specified track.
|
||||
remap (track1) (track2) ... - Remap the current track order.
|
||||
reset - Causes the CD audio to re-initialize.
|
||||
resume - Will resume playback after pause.
|
||||
off - Shuts down the CD audio system..
|
||||
on - Re-enables the CD audio system after a cd off command.
|
||||
pause - Pause the CD playback.
|
||||
play (track number) - Plays the specified track one time.
|
||||
stop - Stops the currently playing track.
|
||||
centerview :
|
||||
Centers the player's view ahead after +lookup or +lookdown
|
||||
Will not work while mlook is active or freelook is 1.
|
||||
changing :
|
||||
Used when maps are changing
|
||||
clear :
|
||||
Clear the console
|
||||
cmd :
|
||||
Send a command to the server.
|
||||
Commands:
|
||||
download - Same as the command.
|
||||
kill - Same as the command.
|
||||
msg (value) - Same as the command.
|
||||
prespawn (entity) (spot) - Find a spawn spot for the player entity.
|
||||
spawn (entity) - Spawn the player entity.
|
||||
setinfo - Same as the command.
|
||||
serverinfo - Same as the command.
|
||||
cmdlist :
|
||||
List all commands
|
||||
color :
|
||||
The pant and shirt color (color shirt pants) Note that if only shirt color is given, pants will match
|
||||
connect :
|
||||
Connect to a server 'connect hostname:port'
|
||||
cvarlist :
|
||||
List all cvars
|
||||
disconnect :
|
||||
Disconnect from server
|
||||
download :
|
||||
Manually download a quake file from the server
|
||||
echo :
|
||||
Print text to console
|
||||
exec :
|
||||
Execute a script file
|
||||
flush :
|
||||
Clears the current game cache
|
||||
force_centerview :
|
||||
Force view of player to center
|
||||
fullinfo :
|
||||
Used by QuakeSpy and Qlist to set setinfo variables
|
||||
fullserverinfo :
|
||||
Used by QuakeSpy and Qlist to obtain server variables
|
||||
gamedir :
|
||||
Specifies the directory to be used while playing.
|
||||
help :
|
||||
Display quake help
|
||||
impulse :
|
||||
Call a game function or QuakeC function.
|
||||
kill :
|
||||
Suicide :)
|
||||
loadsky :
|
||||
Load a skybox
|
||||
loc :
|
||||
Location marker editing commands: 'loc help' for more
|
||||
maplist :
|
||||
List maps available
|
||||
menu_help :
|
||||
Show help menu
|
||||
menu_keys :
|
||||
Show key selection menu
|
||||
menu_main :
|
||||
Show main menu
|
||||
menu_options :
|
||||
Show options menu
|
||||
menu_quit :
|
||||
Show quit question
|
||||
menu_video :
|
||||
Show video selection menu
|
||||
messagemode :
|
||||
Prompt to send a message to everyone
|
||||
messagemode2 :
|
||||
Prompt to send a message to only people on your team
|
||||
nextul :
|
||||
Tells the client to send the next upload
|
||||
packet :
|
||||
Send a packet with specified contents to the destination
|
||||
path :
|
||||
Show what paths Quake is using
|
||||
pause :
|
||||
Pause the game
|
||||
play :
|
||||
Play selected sound effect (play pathto/sound.wav)
|
||||
playdemo :
|
||||
Play a recorded demo
|
||||
playvol :
|
||||
Play selected sound effect at selected volume (playvol pathto/sound.wav num
|
||||
pointfile :
|
||||
Load a pointfile to determine map leaks
|
||||
quit :
|
||||
Exit the program
|
||||
rcon :
|
||||
Issue the set of commands to the server you are currently connected to or have set in rcon_address
|
||||
reconnect :
|
||||
Reconnect to the last server
|
||||
record :
|
||||
Record a demo 'record filename server'
|
||||
rerecord :
|
||||
Rerecord a demo on the same server
|
||||
say :
|
||||
Say something to all other players
|
||||
say_team :
|
||||
Say something only to people on your team
|
||||
screenshot :
|
||||
Take a screenshot and write it as qfxxx.tga in the current directory
|
||||
serverinfo :
|
||||
Report the current server info
|
||||
set :
|
||||
Set the selected variable, useful on the command line (+set variablename setting)
|
||||
setinfo :
|
||||
Sets information about your QuakeWorld user.
|
||||
Used without a key it will list all of your current settings.
|
||||
Specifying a non-existent key and a value will create the new key.
|
||||
Special Keys:
|
||||
b_switch - Determines the highest weapon that Quake should switch to upon a backpack pickup.
|
||||
w_switch - Determines the highest weapon that Quake should switch to upon a weapon pickup.
|
||||
setrom :
|
||||
Set the selected variable and make it read only, useful on the command line.
|
||||
(+setrom variablename setting)
|
||||
sizedown :
|
||||
Decrease the size of the screen
|
||||
sizeup :
|
||||
Increase the size of the screen
|
||||
skins :
|
||||
Download all skins that are currently in use
|
||||
snap :
|
||||
Take a screenshot and upload it to the server
|
||||
soundinfo :
|
||||
Report information on the sound system
|
||||
soundlist :
|
||||
Reports a list of sounds in the cache
|
||||
stop :
|
||||
Stop recording a demo
|
||||
stopsound :
|
||||
Stops all sounds currently being played
|
||||
stopul :
|
||||
Tells the client to stop uploading
|
||||
stuffcmds :
|
||||
Execute the commands given at startup again
|
||||
timedemo :
|
||||
Play a demo as fast as your hardware can. Useful for benchmarking.
|
||||
timerefresh :
|
||||
Tests the current refresh rate for the current location
|
||||
toggle :
|
||||
Toggle a cvar on or off
|
||||
togglechat :
|
||||
Toggle the console up and down
|
||||
toggleconsole :
|
||||
Toggle the console up and down
|
||||
togglemenu :
|
||||
Toggle the menu
|
||||
unalias :
|
||||
Remove the selected alias
|
||||
unbind :
|
||||
Remove the bind from the the selected key
|
||||
unbindall :
|
||||
Remove all binds (USE CAUTIOUSLY!!!)
|
||||
user :
|
||||
Queries the user for his setinfo information
|
||||
users :
|
||||
Report information on connected players and retrieve user ids
|
||||
v_cshift :
|
||||
This adjusts all of the colors currently being displayed.
|
||||
Used when you are underwater, hit, have the Ring of Shadows, or Quad Damage. (v_cshift r g b intensity)
|
||||
version :
|
||||
Report version information
|
||||
wait :
|
||||
Wait a game tic
|
||||
|
|
@ -62,8 +62,8 @@ r cl_autoexec : exec autoexec.cfg on gamedir change
|
|||
r fs_basegame : game to use by default
|
||||
r fs_globalcfg : global configuration file
|
||||
r fs_sharepath : location of shared (read only) game directories
|
||||
r fs_skinbase : location of skins dir for downloads
|
||||
r fs_userpath : location of your game directories
|
||||
gl_flashblend : Toggles the type of lighting for objects
|
||||
* gl_sky_divide : subdivide sky polys
|
||||
* gl_subdivide_size : Sets the division value for the sky brushes.
|
||||
host_speeds : display host processing times
|
||||
|
|
@ -79,7 +79,7 @@ r joy_device : Joystick device
|
|||
* joyaxis5 : Set joystick axes
|
||||
* joyaxis6 : Set joystick axes
|
||||
loadas8bit : Toggles if sounds are loaded as 8-bit samples
|
||||
localid : FIXME: nobody knows what this does.
|
||||
localid : FIXME: This has something to do with client authentication. No Description
|
||||
* lookspring : Snap view to center when moving and no mlook/klook
|
||||
* lookstrafe : when mlook/klook on player will strafe
|
||||
* m_filter : Toggle mouse input filtering.
|
||||
|
|
@ -113,6 +113,7 @@ r joy_device : Joystick device
|
|||
r_netgraph : Toggle the display of a graph showing network performance
|
||||
r_numedges : Toggles the displaying of number of edges currently being viewed
|
||||
r_numsurfs : Toggles the displaying of number of surfaces currently being viewed
|
||||
* r_particles : Toggles drawing of particles.
|
||||
r_polymodelstats : Toggles the displays of number of polygon models current being viewed
|
||||
r_reportedgeout : Toggle the display of how many edges where not displayed
|
||||
r_reportsurfout : Toggle the display of how many surfaces where not displayed
|
||||
|
|
@ -125,6 +126,7 @@ r joy_device : Joystick device
|
|||
rcon_password : remote control password
|
||||
registered : Is the game the registered version. 1 yes 0 no
|
||||
scr_centertime : How long in seconds the screen hints are displayed on the screen
|
||||
* scr_consize : fraction of the screen the console covers when down
|
||||
scr_conspeed : How quickly in the console screen scrolls up and down
|
||||
scr_printspeed : How fast the text is displayed at the end of the single player episodes
|
||||
* sensitivity : mouse sensitivity multiplier
|
||||
|
|
|
|||
134
doc/qf-server-cmd.txt
Normal file
134
doc/qf-server-cmd.txt
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
addip :
|
||||
Add a single IP or a domain of IPs to the IP list of the server.
|
||||
Useful for banning people. (addip (ipnumber))
|
||||
alias :
|
||||
Used to create a reference to a command or list of commands.
|
||||
When used without parameters, displays all current aliases.
|
||||
Note: Enclose multiple commands within quotes and seperate each command with a semi-colon.
|
||||
cmdlist :
|
||||
List all commands
|
||||
cvarlist :
|
||||
List all cvars
|
||||
echo :
|
||||
Print text to console
|
||||
edict :
|
||||
Report information on a given edict in the game. (edict (edict number))
|
||||
edictcount :
|
||||
Display summary information on the edicts in the game.
|
||||
edicts :
|
||||
Display information on all edicts in the game.
|
||||
exec :
|
||||
Execute a script file
|
||||
floodprot :
|
||||
Sets the options for flood protection.
|
||||
Default: 4 4 10
|
||||
(floodprot (number of messages) (number of seconds) (silence time in seconds))
|
||||
floodprotmsg :
|
||||
Sets the message displayed after flood protection is invoked (floodprotmsg message)
|
||||
flush :
|
||||
Clears the current game cache
|
||||
fraglogfile :
|
||||
Enables logging of kills to frag_##.log
|
||||
gamedir :
|
||||
Specifies the directory to be used while playing.
|
||||
give :
|
||||
Give userid items, or health.
|
||||
Items: 1 Axe, 2 Shotgun, 3 Double-Barrelled Shotgun, 4 Nailgun, 5 Super Nailgun, 6 Grenade Launcher, 7 Rocket Launcher,
|
||||
8 ThunderBolt, C Cells, H Health, N Nails, R Rockets, S Shells. Requires cheats are enabled. (give userid item amount)
|
||||
god :
|
||||
Toggle god cheat to userid (god userid) Requires cheats are enabled
|
||||
heartbeat :
|
||||
Force a heartbeat to be sent to the master server.
|
||||
A heartbeat tells the Master the server's IP address and that it is still alive.
|
||||
help :
|
||||
Display quake help
|
||||
kick :
|
||||
Remove a user from the server (kick userid)
|
||||
listip :
|
||||
Print out the current list of IPs on the server list.
|
||||
localinfo :
|
||||
Shows or sets localinfo variables.
|
||||
Useful for mod programmers who need to allow the admin to change settings.
|
||||
This is an alternative storage space to the serverinfo space for mod variables.
|
||||
The variables stored in this space are not broadcast on the network.
|
||||
This space also has a 32-kilobyte limit which is much greater then the 512-byte limit on the serverinfo space.
|
||||
Special Keys: (current map) (next map) - Using this combination will allow the creation of a custom map cycle without editing code.
|
||||
|
||||
Example:
|
||||
localinfo dm2 dm4
|
||||
localinfo dm4 dm6
|
||||
localinfo dm6 dm2
|
||||
(localinfo key value)
|
||||
logfile :
|
||||
Toggles logging of console text to qconsole.log
|
||||
map :
|
||||
Change to a new map (map mapname)
|
||||
maplist :
|
||||
List all maps on the server
|
||||
netdosexpire :
|
||||
FIXME: part of DoS protection obviously, but I don't know what it does. No Description
|
||||
netdosvalues :
|
||||
FIXME: part of DoS protection obviously, but I don't know what it does. No Description
|
||||
noclip :
|
||||
Toggle no clipping cheat for userid. Requires cheats are enabled. (noclip userid)
|
||||
path :
|
||||
Show what paths Quake is using
|
||||
profile :
|
||||
FIXME: Report information about QuakeC Stuff (???) No Description
|
||||
quit :
|
||||
Shut down the server
|
||||
removeip :
|
||||
Remove an IP address from the server IP list. (removeip (ipnumber))
|
||||
say :
|
||||
Say something to everyone on the server, will show up as the name 'console' in game
|
||||
serverinfo :
|
||||
Reports or sets information about server.
|
||||
The information stored in this space is broadcast on the network to all players.
|
||||
Values:
|
||||
dq - Drop Quad Damage when a player dies.
|
||||
dr - Drop Ring of Shadows when a player dies.
|
||||
rj - Sets the multiplier rate for splash damage kick.
|
||||
needpass - Displays the passwords enabled on the server.
|
||||
watervis - Toggle the use of r_watervis by OpenGL clients.
|
||||
Note: Keys with (*) in front cannot be changed. Maximum key size cannot exceed 64-bytes.
|
||||
Maximum size for all keys cannot exceed 512-bytes.
|
||||
(serverinfo key value)
|
||||
set :
|
||||
Set the selected variable, useful on the command line (+set variablename setting)
|
||||
setmaster :
|
||||
Lists the server with up to eight masters.
|
||||
When a server is listed with a master, the master is aware of the server's IP address and port and it is added to the
|
||||
list of current servers connected to a master. A heartbeat is sent to the master from the server to indicated that the
|
||||
server is still running and alive.
|
||||
|
||||
Examples:
|
||||
setmaster 192.246.40.12:27002
|
||||
setmaster 192.246.40.12:27002 192.246.40.12:27004
|
||||
setrom :
|
||||
Set the selected variable and make it read only, useful on the command line.
|
||||
(+setrom variablename setting)
|
||||
snap :
|
||||
FIXME: Take a screenshot of userid? No Description
|
||||
snapall :
|
||||
FIXME: No Description
|
||||
status :
|
||||
Report information on the current connected clients and the server - displays userids
|
||||
stuffcmds :
|
||||
Execute the commands given at startup again
|
||||
sv_gamedir :
|
||||
Displays or determines the value of the serverinfo *gamedir variable.
|
||||
Note: Useful when the physical gamedir directory has a different name than the widely accepted gamedir directory.
|
||||
Example:
|
||||
gamedir tf2_5; sv_gamedir fortress
|
||||
gamedir ctf4_2; sv_gamedir ctf
|
||||
(sv_gamedir dirname)
|
||||
toggle :
|
||||
Toggle a cvar on or off
|
||||
unalias :
|
||||
Remove the selected alias
|
||||
user :
|
||||
Report information about the user (user userid)
|
||||
wait :
|
||||
Wait a game tic
|
||||
writeip :
|
||||
Record all IP addresses on the server IP list. The file name is listip.cfg
|
||||
|
|
@ -13,7 +13,9 @@
|
|||
r fs_basegame : game to use by default
|
||||
r fs_globalcfg : global configuration file
|
||||
r fs_sharepath : location of shared (read only) game directories
|
||||
r fs_skinbase : location of skins dir for downloads
|
||||
r fs_userpath : location of your game directories
|
||||
* gl_subdivide_size : Sets the division value for the sky brushes.
|
||||
s hostname : Report or sets the server name
|
||||
s maxclients : Sets how many clients can connect to your server, this includes spectators and players
|
||||
s maxspectators : Sets how many spectators can connect to your server. The maxclients value takes precidence over this value so this value should always be equal-to or less-then the maxclients value
|
||||
|
|
@ -22,6 +24,7 @@ r fs_userpath : location of your game directories
|
|||
pausable : Toggle if server can be paused 1 is on, 0 is off
|
||||
pr_boundscheck : Server progs bounds checking
|
||||
qport : The internal port number for the game networking code.Useful for clients who use multiple connections through one IP address (NAT/IP-MASQ) because default port is random.
|
||||
s r_skyname : name of skybox
|
||||
rcon_password : Set the password for rcon commands
|
||||
registered : Is the game the registered version. 1 yes 0 no
|
||||
s samelevel : Determines the rules for level changing and exiting. 0 Allows advancing to the next level,1 The same level will be played until someone exits,2 The same level will be played and the exit will kill anybody that tries to exit,3 The same level will be played and the exit will kill anybody that tries to exit, except on the Start map.
|
||||
|
|
@ -47,6 +50,7 @@ r fs_userpath : location of your game directories
|
|||
sv_mintic : The minimum amount of time the server will wait before sending packets to a client. Set to .5 to make modem users happy
|
||||
sv_netdosprotect : DoS flood attack protection
|
||||
sv_phs : Possibly Hearable Set. If set to zero, the server calculates sound hearability in realtime
|
||||
r sv_progs : Allows selectable game progs if you have several of them in the gamedir
|
||||
sv_spectalk : Toggles the ability of spectators to talk to players
|
||||
sv_spectatormaxspeed : Sets the maximum speed a spectator can move
|
||||
sv_stopspeed : Sets the value that determines how fast the player should come to a complete stop
|
||||
|
|
@ -57,11 +61,13 @@ r fs_userpath : location of your game directories
|
|||
sv_timestamps : Time/date stamps in log entries
|
||||
sv_wateraccelerate : Sets the water acceleration value
|
||||
sv_waterfriction : Sets the water friction value
|
||||
sys_dead_sleep : When set, the server gets NO cpu if no clients are connected and there's no other activity. *MIGHT* cause problems with some mods.
|
||||
sys_dead_sleep : When set, the server gets NO cpu if no clients are connectedand there's no other activity. *MIGHT* cause problems withsome mods.
|
||||
sys_extrasleep : Set to cause whatever amount delay in microseconds you want. Mostly useful to generate simulated bad connections.
|
||||
sys_nostdout : Toggles console screen output
|
||||
s teamplay : Determines teamplay rules. 0 off, 1 You cannot hurt yourself nor your teammates, 2 You can hurt yourself, your teammates, and you will lose one frag for killing a teammate3 You can hurt yourself but you cannot hurt your teammates
|
||||
s timelimit : Sets the amount of time in minutes that is needed before advancing to the next level
|
||||
timeout : Sets the amount of time in seconds before a client is considered disconnected if the server does not receive a packet
|
||||
vid_height : User-created cvar
|
||||
vid_width : User-created cvar
|
||||
s watervis : Toggle the use of r_watervis by OpenGL clients
|
||||
zombietime : The number of seconds that the server will keep the character of a player on the map who seems to have disconnected
|
||||
|
|
|
|||
Loading…
Reference in a new issue