diff --git a/doc/quakeforge-notes.txt b/doc/quakeforge-notes.txt new file mode 100644 index 000000000..4049748c2 --- /dev/null +++ b/doc/quakeforge-notes.txt @@ -0,0 +1,19 @@ +
    +
  1. There are no menus in the current code so the ESC key will take you to the console rather than the menus that are AWOL
    2. +
  2. sensitivity is gone. In it's place are in_amp, in_pre_amp, in_mouse_amp and in_mouse_pre_amp, which all multiply together to give you the old sensitivity
    3. +
  3. By default, you will not get any sound output (in fact you will get a warning about being unable to load the null plugin). use +set snd_output plugin on the command line. plugin is one of: + +Once you have determined which plugin you wish to use, you can put set snd_output plugin into quakeforge.conf which QuakeForge will look for in /etc in UNIX and %WINDIR% in MS-Windows (unless the HOME environment variable is set to a directory, in which case, QuakeForge will look there)
    4. +
  4. Any set cvar value command can be placed in this file: one per line.
    5. +
  5. All commands prefixed by a + on the command line will be executed. (eg, qw-client-x11 +set cl_writecfg 0 +connect quake.server.dom will execute set cl_writecfg 0 and connect quake.server.dom as separate commands)
    6. +
  6. In UNIX, QuakeForge defaults to looking for the game directories in $prefix/share/games/quakeforge (fs_sharepath) and ~/.quakeforge (fs_userpath).
    7. +
  7. In MS-Windows, QuakeForge defaults to looking for the game directories in the traditional location (the current directory). fs_sharepath and fs_userpath are available to MS-Windows users, they both default to "."
    8. +
  8. QuakeForge only ever writes files to fs_userpath, never to fs_sharepath and QuakeForge will search for files within fs_userpath before looking in fs_sharepath
    9. +
  9. Um, I'm tired. You're lucky you got these docs :P. More will follow
    10. +
diff --git a/doc/qw-server-cmd.txt b/doc/qw-server-cmd.txt new file mode 100644 index 000000000..658bf9c24 --- /dev/null +++ b/doc/qw-server-cmd.txt @@ -0,0 +1,152 @@ +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. +ban : +ban a player for a specified time +cache_flush : +Clears the current game cache +cache_print : +Prints out items in the cache +cache_profile : +Prints a profile of the current cache +cmdlist : +List all commands +cuff : +"hand-cuff" a player for a specified time +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) +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 to be 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 help for a command or variable +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 +match : +matches nicks as ban/cuff/mute commands do, so you can check safely +mute : +silience a player for a specified time +net_packetlog_zap : +clear the packet log file +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 to be 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' (or 'Admin') in game +sayinfo : +Say something to everyone on the server. Will show up as the name 'Info' 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) +tell : +Say something to a specific user on the server. Will show up as the name 'Console' (or 'Admin') in game +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 diff --git a/doc/qw-server-cvar.txt b/doc/qw-server-cvar.txt new file mode 100644 index 000000000..a30cbc38b --- /dev/null +++ b/doc/qw-server-cvar.txt @@ -0,0 +1,98 @@ + admin_password : Set the password for rcon admin commands + allow_download : Toggle if clients can download game data from the server + allow_download_maps : Toggle if clients can download maps from the server + allow_download_models : Toggle if clients can download models from the server + allow_download_skins : Toggle if clients can download skins from the server + allow_download_sounds : Toggle if clients can download sounds from the server + cl_rollangle : How much a player's screen tilts when strafing + cl_rollspeed : How quickly a player straightens out after strafing + cmd_highchars : Toggles availability of special characters by proceeding letters by $ or #. See the documentation for details. + cmd_warncmd : Toggles the display of error messages for unknown commands +r crudefile_quota : Maximum space available to the Crude File system, -1 to totally disable file writing + s deathmatch : Sets the rules for weapon and item respawning. 1 Does not leave weapons on the map. You can pickup weapons and items and they will respawn, 2 Leaves weapons on the map. You can only pick up a weapon once. Picked up items will not respawn, 3 Leaves weapons on the map. You can only pick up a weapon once. Picked up items will respawn. + developer : set to enable extra debugging information + filterban : Determines the rules for the IP list 0 Only IP addresses on the Ban list will be allowed onto the server, 1 Only IP addresses NOT on the Ban list will be allowed onto the server + s fraglimit : Amount of frags a player must attain in order to exit the level +r fs_basegame : game to use by default +r fs_globalcfg : global configuration file +r fs_pluginpath : Location of your plugin directory +r fs_sharepath : location of shared (read only) game directories +r fs_skinbase : location of skins dir for downloads +r fs_usercfg : user configuration file +r fs_userpath : location of your game directories + * gl_mesh_cache : minimum triangle count in a model for its mesh to be cached. 0 to disable caching + * 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 precedence over this value so this value should always be equal-to or less-then the maxclients value + net_loglevel : Packet logging/parsing + net_packetlog : enable/disable packet logging + s no_pogo_stick : disable the ability to pogo stick + password : Set the server password for players + pausable : Toggle if server can be paused 1 is on, 0 is off + pr_boundscheck : Server progs bounds checking +r pr_checkextensions : indicate the presence of the checkextentions qc function + pr_deadbeef_ents : set to clear unallocated memory to 0xdeadbeef + pr_deadbeef_locals : set to clear uninitialized local vars to 0xdeadbeef + pr_debug : enable progs debugging + pr_double_remove : Handling of double entity remove. 0 is silently ignore, 1 prints a traceback, and 2 gives an error. Only works if debugging is available and enabled + pr_gc : Enable/disable the garbage collector. 0 is off, 1 is on, 2 is auto (on for newer qfcc progs, off otherwise) + pr_gc_interval : Number of frames to wait before running string garbage collector. + pr_source_path : where to look (within gamedir) for source files + 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. + r_lightmap_components : User-created cvar + s r_skyname : name of skybox + rcon_password : Set the password for rcon 'root' 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. + showdrop : Toggle the display of how many packets you are dropping + showpackets : Show all network packets + snd_device : User-created cvar + snd_output : User-created cvar + s spawn : Spawn the player entity + spectator_password : Set the spectator password + sv_3133735_7h4n_7h0u : Match '1' as 'i' and such in nicks + sv_accelerate : Sets the acceleration value for the players + sv_aim : Sets the value for auto-aiming leniency + sv_airaccelerate : Sets how quickly the players accelerate in air + sv_allow_log : Allow remote logging + sv_allow_pings : Allow remote pings (qstat etc) + sv_allow_status : Allow remote status queries (qstat etc) +r sv_console_plugin : Plugin used for the console + sv_extensions : Use protocol extensions for QuakeForge clients + sv_filter_automask : Automatically determine the mask length when it is not explicitely given. e.g. "addip 1.2.0.0" would be the same as "addip 1.2.0.0/16" + sv_friction : Sets the friction value for the players + sv_gravity : Sets the global value for the amount of gravity +r sv_hide_version_info : hide QuakeForge specific serverinfo strings from terminally stupid progs (eg, braindead TF variants) + sv_highchars : Toggle the use of high character color names for players + sv_kickfake : Kick users sending to send fake talk messages + sv_mapcheck : Toggle the use of map checksumming to check for players who edit maps to cheat + s sv_maxrate : Maximum allowable rate + sv_maxspeed : Sets the maximum speed a player can move + sv_maxtic : The maximum amount of time in seconds before a client a receives an update from the server + sv_maxvelocity : Sets the maximum velocity an object can travel + s sv_minqfversion : Minimum QF version on client + 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_old_entity_free : set this for buggy mods that rely on the old behaviour of entity freeing (eg, *TF) + sv_phs : Possibly Hearable Set. If set to zero, the server calculates sound hearability in realtime + 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 + sv_timefmt : Time/date format to use + s sv_timekick : Time cheat protection + sv_timekick_fuzz : Time cheat "fuzz factor" + sv_timekick_interval : Time cheat check interval + 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_extrasleep : Set to cause whatever amount delay in microseconds you want. Mostly useful to generate simulated bad connections. + sys_nostdout : Set to disable std out + sys_sleep : Sleep how long in seconds between checking for connections. Minimum is 0, maximum is 13 + 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 teammate, 3 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 + 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