* Add documentation for cl_guid in the README

This commit is contained in:
Tony J. White = 2007-02-13 16:18:35 +00:00
parent 2cddf1208d
commit 7379c3920f

20
README
View file

@ -23,6 +23,7 @@ for further development. Some of the major features currently implemented are:
* Much improved QVM tools * Much improved QVM tools
* Support for various esoteric operating systems (see * Support for various esoteric operating systems (see
http://ioquake3.org/?page=status) http://ioquake3.org/?page=status)
* cl_guid support
* HTTP/FTP download redirection (using cURL) * HTTP/FTP download redirection (using cURL)
* Multiuser support on Windows systems (user specific game data * Multiuser support on Windows systems (user specific game data
is stored in "%APPDATA%\Quake3") is stored in "%APPDATA%\Quake3")
@ -149,6 +150,7 @@ New cvars
cl_platformSensitivity - read only, indicates the mouse input cl_platformSensitivity - read only, indicates the mouse input
scaling scaling
r_ext_texture_filter_anisotropic - anisotropic texture filtering r_ext_texture_filter_anisotropic - anisotropic texture filtering
cl_guidServerUniq - makes cl_guid unique for each server
cl_cURLLib - filename of cURL library to load cl_cURLLib - filename of cURL library to load
sv_dlURL - the base of the HTTP or FTP site that sv_dlURL - the base of the HTTP or FTP site that
holds custom pk3 files for your server holds custom pk3 files for your server
@ -204,6 +206,24 @@ Creating mods compatible with Q3 1.32b
compiler. See http://www.quakesrc.org/forums/viewtopic.php?t=5665 (if it compiler. See http://www.quakesrc.org/forums/viewtopic.php?t=5665 (if it
still exists when you read this) for more details. still exists when you read this) for more details.
cl_guid Support
cl_guid is a cvar which is part of the client's USERINFO string. Its value
is a 32 character string made up of [a-f] and [0-9] characters. This
value is pseudo-unique for every player. Id's Quake 3 Arena client also
sets cl_guid, but only if Punkbuster is enabled on the client.
If cl_guidServerUniq is non-zero (the default), then this value is also
pseudo-unique for each server a client connects to (based on IP:PORT of
the server).
The purpose of cl_guid is to add an identifier for each player on
a server. This value can be reset by the client at any time so it's not
useful for blocking access. However, it can have at least two uses in
your mod's game code:
1) improve logging to allow statistical tools to index players by more
than just name
2) granting some weak admin rights to players without requiring passwords
Using HTTP/FTP Download Support (Server) Using HTTP/FTP Download Support (Server)
You can enable redirected downloads on your server even if it's not You can enable redirected downloads on your server even if it's not
an ioquake3 server. You simply need to use the 'sets' command to put an ioquake3 server. You simply need to use the 'sets' command to put