diff options
| -rw-r--r-- | wiki/contact.mdwn | 21 | ||||
| -rw-r--r-- | wiki/doc.mdwn | 2 | ||||
| -rw-r--r-- | wiki/doc/client.mdwn | 32 | ||||
| -rw-r--r-- | wiki/doc/q2pro.menu | 2 | ||||
| -rw-r--r-- | wiki/doc/server.mdwn | 8 | ||||
| -rw-r--r-- | wiki/download.mdwn | 76 | ||||
| -rw-r--r-- | wiki/download/apt.mdwn | 49 | ||||
| -rw-r--r-- | wiki/index.mdwn | 58 |
8 files changed, 167 insertions, 81 deletions
diff --git a/wiki/contact.mdwn b/wiki/contact.mdwn index 9c37be6..223d721 100644 --- a/wiki/contact.mdwn +++ b/wiki/contact.mdwn @@ -1,14 +1,13 @@ -There are mailing lists set up: +For reporting bugs and proposing enhancements to Q2PRO, +please use the [bug tracker][1]. No registration is required to +view and create new tickets (although it is trivial to register)! -* [q2pro-user](https://lists.sourceforge.net/lists/listinfo/q2pro-user) - at lists.sourceforge.net (general discussion and support) -* [q2pro-devel](https://lists.sourceforge.net/lists/listinfo/q2pro-devel) - at lists.sourceforge.net (patches, etc) +There is also Q2PRO [forum][2] available (in Russian language), +hosted by the [Russian Quake 2 Portal][3]. -There is also Q2PRO [forum](http://forum.quake2.com.ru/viewforum.php?f=6) -available (in Russian), hosted by the [Russian Quake2 Portal](http://quake2.com.ru/). +You can also drop a e-mail to Q2PRO [author][4] directly. -IRC channel for Q2PRO is #q2pro at irc.quakenet.org. - -See [this](http://skuller.ath.cx/) page if you wish to contact -Q2PRO author directly. +[1]: http://skuller.net/q2pro/cvstrac/index +[2]: http://forum.quake2.com.ru/viewforum.php?f=6 +[3]: http://quake2.com.ru/ +[4]: http://skuller.net/ diff --git a/wiki/doc.mdwn b/wiki/doc.mdwn index 6e3136d..e35af85 100644 --- a/wiki/doc.mdwn +++ b/wiki/doc.mdwn @@ -4,4 +4,4 @@ Documentation for Q2PRO. * [[Client]] commands and cvars. * Building instructions for Win32 hosted [[MinGW]]. * Some technical [[netcode]] details. -* Online Q2PRO [configurator](http://skuller.ath.cx/q2pro/config.cgi). +* Online Q2PRO [configurator](/q2pro/config.cgi). diff --git a/wiki/doc/client.mdwn b/wiki/doc/client.mdwn index 990f63d..f11785c 100644 --- a/wiki/doc/client.mdwn +++ b/wiki/doc/client.mdwn @@ -105,6 +105,13 @@ Specifies command to be executed each time client disconnects from the server. Effects ---------- +Colors can be specified in one of the following formats: + +- \#RRGGBBAA, where R, G, B and A are hex digits +- \#RRGGBB, which implies alpha value of FF +- \#RGB, which is expanded to \#RRGGBB by duplicating digits +- one of the predefined color names (black, red, etc) + Alternative beam based rail trail effect is available only when using OpenGL refresh library. In software mode original particle based effect is used unconditionally. @@ -149,6 +156,11 @@ Specifies if ambient sounds are played: - 2 - only ambient sounds from visible entities are enabled (rocket flyby, etc) - 3 - only ambient sounds from player entity are enabled (railgun hum, hand grenade ticks, etc) +- `set s_enable 1` (integer) +Specifies what sound engine to use: + - 0 - sound is disabled + - 1 - use default DMA sound engine + - 2 - use OpenAL sound engine Console ---------- @@ -308,9 +320,23 @@ Default value means to try \*.png first, then \*.jpg, then \*.tga. Misc ---------- -- `set in_direct 1` (boolean) -Enables direct mouse input if supported on your platform. Otherwise, -standard input facilities provided by the window system are used. +- `set in_direct 1` (boolean) +Enables direct mouse input if supported on your platform (DirectInput on Windows +and Evdev interface on Linux). Otherwise, standard input facilities provided +by the window system are used. + +- `set in_device ""` (string) +On Linux, specifies device file to use for direct mouse input. Normally, it should +be one of `/dev/input/eventX` files (reading permissions are required). + +- `set lirc_enable 0` (boolean) +On Linux, enables input from the LIRC daemon, which allows menu navigation and +command execution from your infrared remote control device. + +- `set lirc_config ""` (string) +On Linux, specifies LIRC configuration file to use. Empty string means to use +the default `~/.lircrc` file. This variable may only be set from command line. +See README.lirc file in Q2PRO distribution for command syntax description. - `set cl_chat_notify 1` (boolean) Specifies whether to display chat lines in the notify area. diff --git a/wiki/doc/q2pro.menu b/wiki/doc/q2pro.menu index baba96a..d996ae7 100644 --- a/wiki/doc/q2pro.menu +++ b/wiki/doc/q2pro.menu @@ -148,7 +148,7 @@ begin game action "Servers" pushmenu servers action "Demos" pushmenu demos action "Options" pushmenu options - action "Disconnet" disconnect + action "Disconnect" disconnect action "Quit" quit end diff --git a/wiki/doc/server.mdwn b/wiki/doc/server.mdwn index 09207fb..6795828 100644 --- a/wiki/doc/server.mdwn +++ b/wiki/doc/server.mdwn @@ -72,7 +72,7 @@ See above. If empty, no one is allowed to occupy reserved slot(s), except of dummy MVD observer. Clients set their passwords via `password` userinfo variable. - `set sv_lan_force_rate 0` (boolean) -When enabled, do not enforce any rate limits for clients whose IP is from +When enabled, do not enforce any rate limits on clients whose IP is from private address space (127.x.x.x, 10.x.x.x, 192.168.x.x, 172.16.x.x). - `set sv_ghostime 6` (float) @@ -84,7 +84,7 @@ Helps to avoid attacks flooding server with zombie clients, combined with `sv_iplimit` variable. - `set sv_force_reconnect ""` (string) -When set to address string, forces new clients to quickly reconnect to +When set to an address string, forces new clients to quickly reconnect to this address as an additional proxy protection measure. - `set sv_show_name_changes 0` (boolean) @@ -92,7 +92,7 @@ Broadcast player name changes to everyone. You should probably enable this unless game mod already shows name changes. - `set sv_uptime 0` (boolean) -Display uptime string in server info. +Include ‘uptime’ key/value pair in server info. MVD/GTV server @@ -109,7 +109,7 @@ Total number of MVD/GTV client slots on the server. - `set sv_mvd_password ""` (string) Password used to authenticate MVD/GTV clients. If password is not set, only those clients -can connect, whose IP address is added to the list of trusted MVD/GTV hosts using ‘addgtvhos +can connect, whose IP address is added to the list of trusted MVD/GTV hosts using ‘addgtvhost’ command. - `set sv_mvd_nogun 1` (boolean) diff --git a/wiki/download.mdwn b/wiki/download.mdwn index a1ea7e2..b03074a 100644 --- a/wiki/download.mdwn +++ b/wiki/download.mdwn @@ -1,55 +1,51 @@ -Debian GNU/Linux ----------------- -Prebuilt Q2PRO packages are available for the stable Debian distribution -for i386 and amd64 architectures. +Stable releases +--------------- -In order to get Q2PRO repository contents automatically managed by APT, -add the following lines into your `/etc/apt/sources.list` file: +Current stable version of Q2PRO client for Win32 is **r364** +([q2pro-client_r364_win32_x86_anticheat.zip][1], 1.2 M). +This version is supported by r1ch.net anticheat. +Thanks, R1CH, for building this version! - deb http://skuller.ath.cx/debian/ lenny q2pro - deb-src http://skuller.ath.cx/debian/ lenny q2pro +Current stable version of Q2PRO server is **r396**. +GNU/Linux and Win32 builds are found in the [stable/][2] directory, +along with source snapshots. If you are running older Q2PRO server +version, you are highly recommended to upgrade. -Users of Secure APT also need to import the repository signing key: +[1]: http://antiche.at/files/q2pro-client_r364_win32_x86_anticheat.zip +[2]: /q2pro/download/stable/ - wget -q -O - http://skuller.ath.cx/debian/archive.key | apt-key add - +Users of Debian GNU/Linux and compatible distributions can +conveniently install prebuilt Q2PRO client and server packages +from the [[APT repository|apt]]. -Finally, run the following commands to install or upgrade Q2PRO: +Unstable builds +--------------- - aptitude update - aptitude install q2pro-client # install the graphical client - aptitude install q2pro-server # install the dedicated server +Latest GNU/Linux server builds and Win32 client and server +builds from SVN trunk are available in the [unstable/][3] directory, +along with source snapshots. You might also find development +[timeline page][4] useful for tracking latest changes. -It is also possible to download the individual [.deb][debs] packages -and install them manually using `dpkg -i` command. +[3]: /q2pro/download/unstable/ +[4]: /q2pro/cvstrac/timeline -Note that Q2PRO packages above are not providing any game media files -for Quake 2 like textures and maps. You need to install them yourself, -otherwise graphical client won't run. +SVN access +---------- -[debs]: http://skuller.ath.cx/debian/pool/q2pro/ - -Nightly builds ----------------- -Generic GNU/Linux and Win32 binary builds from SVN trunk are -[available][nightly], along with source snapshots. You might also -find SVN [changelog][svnlog] useful. +To get the latest Q2PRO source code, you need to install Subversion +client. Use the following command to checkout a fresh working copy into +the `q2pro` directory: -[nightly]: http://skuller.ath.cx/q2pro/nightly/ -[svnlog]: http://q2pro.svn.sourceforge.net/viewvc/q2pro?view=log + svn co svn://skuller.net/q2pro/trunk q2pro -Source code ----------------- -To get the latest Q2PRO source code, you will need to install Subversion -client. Use the following command to checkout fresh working copy into -the `q2pro` directory: +You can also [browse][5] Q2PRO source tree online. - svn co https://q2pro.svn.sourceforge.net/svnroot/q2pro/trunk q2pro +[5]: /q2pro/cvstrac/dir?d=trunk -If you are looking for the source code snapshot corresponding to -a stable binary release, try the following command, replacing XXX -with release number: +Archived builds +--------------- - svn co https://q2pro.svn.sourceforge.net/svnroot/q2pro/tags/rXXX q2pro-rXXX +Previous Q2PRO versions of historic interest are available +in the [attic/][6] directory. -You can also [browse](http://q2pro.svn.sourceforge.net/viewvc/q2pro/) -Q2PRO source tree online. +[6]: /q2pro/download/attic/ diff --git a/wiki/download/apt.mdwn b/wiki/download/apt.mdwn new file mode 100644 index 0000000..f71f3e6 --- /dev/null +++ b/wiki/download/apt.mdwn @@ -0,0 +1,49 @@ +APT repository +---------------- +Prebuilt Q2PRO packages are available for the stable Debian distribution +for i386 and amd64 architectures. Built in Debian 5.0 ‘Lenny’ environment, +these packages are expected to install in testing/unstable branches as well, +even Ubuntu users may give them a try. + +In order to get Q2PRO repository contents automatically managed by APT, +add the following lines into your `/etc/apt/sources.list` file (you need +root privileges for this): + + deb http://skuller.net/debian/ lenny q2pro + deb-src http://skuller.net/debian/ lenny q2pro + +Users of Secure APT also need to import the repository signing key: + + wget -q -O - http://skuller.net/debian/archive.key | apt-key add - + +Finally, run the following commands to install or upgrade Q2PRO: + + aptitude update + aptitude install q2pro-client # install the graphical client + aptitude install q2pro-server # install the dedicated server + +Of course, it is also possible to download the individual [packages][1] +manually and install them using `dpkg -i` command. + +Please note that Q2PRO packages above are not providing any game media +files for Quake 2 like textures and maps. You have to install them yourself, +otherwise graphical client won't run. + +By default only base Quake 2 game library is installed, which provides +the single player campaign (not quite useful for Q2PRO) and a very +limited deathmatch mode. Thus, you will probably want to install some +additional game mods. + +Right now, two open source multiplayer mods configured for use with Q2PRO +server are also packaged: [OpenTDM][2] and [OpenFFA][3]. Run the following +commands to install them: + + aptitude install q2pro-opentdm # install OpenTDM + aptitude install q2pro-openffa # install OpenFFA + +Then, run `q2pro` or `q2proded` with `+set game opentdm` or `+set game openffa` options. + +[1]: /debian/pool/q2pro/ +[2]: http://opentdm.net/ +[3]: /openffa/ + diff --git a/wiki/index.mdwn b/wiki/index.mdwn index 60cf245..6473956 100644 --- a/wiki/index.mdwn +++ b/wiki/index.mdwn @@ -1,33 +1,44 @@ Introduction ----------------- -Q2PRO is a [Quake 2][q2] engine modification, based on source code released +Q2PRO is a [Quake 2][1] engine modification, based on source code released under the terms of GPL by id Software. This is not a standalone game as it does not provide any media content, but rather a backwards compatible enhancement over original Quake 2 release designed for multiplayer use. -Currently, Q2PRO does not support Quake 2 singleplayer mode, although this -may change in the future. +Backwards compatibility is defined in terms of full network protocol and +file format compatibility. Do not expect Q2PRO to be a drop-in replacement +for your original Quake 2 client — although it is (and will always be) +very close to the ‘vanilla’ Quake 2 look and feel. -[q2]: http://en.wikipedia.org/wiki/Quake_2 "id Software's Quake II" +Being focused on multiplayer, Q2PRO does not fully support Quake 2 singleplayer +mode, although this may change in the future. + +[1]: http://en.wikipedia.org/wiki/Quake_2 "id Software's Quake II" Important news ----------------- -* __2008-Oct-30:__ Q2PRO server versions from [r307 and up][dl] now implement +* __2009-May-29:__ Q2PRO SVN repository has been migrated to skuller.net + from Source Forge, with OpenFFA split up in a separate [project][2]. + Also, a [bug tracker][3] has been set up for Q2PRO. Feel free to use it + for reporting bugs and proposing enhancements. No registration is required! + +[2]: /openffa/ +[3]: /q2pro/cvstrac/index + +* __2008-Oct-30:__ Q2PRO server versions from r307 and up now implement improved MVD/GTV protocol capable of automatic connection recovery and feature special ‘suspension mode’ for additional bandwidth savings in case there are no players/spectators on a channel. -[dl]: http://skuller.ath.cx/q2pro/nightly/ - - Feature highlights ----------------- * __Performance increases.__ OpenGL renderer has been completely rewritten to take full advantage of capabilities of modern hardware. By greatly reducing driver overhead, Q2PRO provides performace - increases up to 200% of default Quake 2 renderer speed. + increases up to 200% of default Quake 2 renderer speed, especially on + open source GNU/Linux video drivers for Intel and ATI/AMD hardware. * __Enhanced console input.__ Autocompletes not just command and cvar names, but also arguments of many frequently used commands. Graphical client console @@ -40,19 +51,21 @@ Feature highlights * __Integrated demo and server browsers.__ Allows one to easily navigate through their demo collection by providing integrated demo browser. Address book - functionality is greatly improved by providing integrated server browser. + functionality is improved by providing integrated server browser. -* __Multi View Demo support.__ Server is capable of recording and playing - back demos in special MVD format, capturing views from each player in game. +* __Multi view demo support.__ Server is capable of recording and playing + back demos in custom MVD format, capturing views from each player in game. During playback, spectators themselves choose which view they would like to watch. This is completely transparent to and supported for _any_ Quake 2 - client connected to a Q2PRO server. + client connected to Q2PRO server. -* __Game TeleVision support.__ Server may act as game relay node, allowing +* __Game television support.__ Server may act as game relay node, allowing large amount of spectators watch game in real time without putting any additional load on the game server itself. Furthermore, live game streaming is done with all benefits of MVD format. There is no need for ‘camera man’, - unlike other GTV implementations. + unlike other GTV implementations. To prevent cheating, GTV server delays + the MVD stream by adjustable amount of time (typically 20-30 seconds) before + it is shown to spectators. * __Frame rates separation.__ Client provides ‘true’ networking, physics, rendering and input polling frame rates separation. Unlike other Quake 2 @@ -62,12 +75,15 @@ Feature highlights * __Improved security and stability.__ Developed with security in mind, Q2PRO carefully handles all untrusted data, including data coming from the network - as well as locally stored files like game media, which could be potentionally - downloaded from an untrusted location. + as well as static files like game media, which are often downloaded + from untrusted locations. Q2PRO is probably the only Quake 2 client out there + that strives to gracefully handle all kind of incorrect input, like malformed + maps, sounds and images. -* __Support for multiple platforms.__ Client and server run natively on - Win32 as well as many UNIX-like systems, where Q2PRO client uses highly - portable SDL library for graphical and sound output. +* __Support for multiple platforms.__ Client and server are portable enough + to run natively on Win32/x86 as well as many UNIX-like systems across + different CPU arches. The only dependency of Q2PRO server is Zlib, while + Q2PRO client uses highly portable SDL library for graphical and sound output. Navigation ----------------- @@ -75,5 +91,5 @@ Navigation * [[download]] * [[documentation|doc]] * [[contact]] -* [project page at SF.net](http://sourceforge.net/projects/q2pro/) +* [bug tracker](/q2pro/cvstrac/index) |