QW262 by [2WP]BorisU revision 10

Major advances of QW262

• TeamFortress anti-flash and anti-concussion cheats are disabled (old grens on).
• GL version in TeamFortress now has the flash and gas grenade effects working in the same way as in software rendering.
• GL version allows in-game gamma and contrast change.
• A new algorithm of demo recording with delta_compression is implemented. Standard QW clients have delta_compression turned off by default while recording a demo and this usually results in undesired ping and PL increases.
• A built-in support for some proxy functions like:
  loc-files of two types (qizmo and QW262 block format);
  message macros (%l, %a, %h etc.). some of which are strongly improved. For example, one can transmit his map coordinates which means that anyone can interpret them acoording to his own loc-files.
• Advanced message filtering;
• Some fps-filter features.
• Improved demo handling (easy browsing over all quake folders) and playback (including QWZ and MVD demos).
• Improved console editing.
• You can bind such buttons as capslock, numlock and all buttons of numeric pad separately.
• Mice with 4 and more buttons are supported.
• Configurable hud allows to display a wide range of info during the gameplay (for example health, armor, ammo or value of any desired variable).
• For even higher anti-cheating safety the ability to work on a rewritten protocol is implemented. Using QW262 server in such a way makes it incompatible with other clients and proxies.

Extra features

• Improved script handling. Naturally, it looks like a special QW262 macro language which includes:
  • powerful variable processing (expansion, search and etc.)
  • improved work with aliases (increased speed, special features for complex aliases, aliases with parameters)
  • math feature - addition, substraction, multiplication and others
  • conditional execution of commands - if/then/else
  • improved logging
• Ability of automation of certain actions by means of triggers and regexp-triggers. This is apparently one of the most powerful tools for reacting to in-game events! At the moment on the basis of almost any message appearing on the screen one can provide execution of a certain alias. The application area is immense, but the minimal use is an advanced teammate communication system.

New settings and abilities

The client is automatically responding the f_version queue sent by any player in messagemode 1. The answer is sent only one time in 20 seconds to avoid spamming.

If your config has a line containing setinfo uid nick, this nick becomes your id-name (any string up to 5 symbols will fit, case-sensitive). This is convenient if you have lots of nicks but still want your friends to recognize you. Uid can be viewed in userinfo and everybody using QW262 can do so using users command. Some commands in QW2.62 recognize and use uid in the same manner as id of a player.

The volume of a sound produced by play and playvol commands doesn't depend on a current distance from the place where thesecommands were issued. This is very handy for grenade-timers in TeamFortress.

While opening the console the view on the remaining part of the screen is corrected in the software version (works like in Unreal so that you don't miss any event when working in the console). Users of the GL version can adjust transparency of the console by a gl_conalpha variable (default is 0.8). At values about 0.3 the console is transparent enough and there's no need for the view correction.

Client automatically determines if the server using jump-fix and tunes prediction accordingly.

Some variables have changed limits

Visual settings

GL version specific.

LIT-files are supported (static colored lighting). They are loaded from maps or lits directories. Works only if gl_colorlights cvar is set to 1.

It is possible to use 24/32bit JPG, PNG, TGA and PCX (file search is performed in this order!) textures up to 2048x2048 size. When loading 'test' texture the client first look for test.link (link to other texture), then test.jpg, test.png, test.tga, test.pcx and finally for standard 8bit texture. If the name of the texture starts from '*' it is replaced by '#'. Fullbright colors on 24/32bit textures are supported only if server permits it through 'serverinfo allow_24bit_fullbrights 1' - currently disabled.

It is possible to use 24/32bit textures for bsp-models, alias models, sprites, elements of quake interface (menu, statusbar), skyboxes and crosshairs. The following table summarizes the directories where textures shoul be placed:

Console background can be loaded from textures/gfx/conback.* file. Console font can be loaded from textures/charset.*.

Some words abount .link file. This is a plaintext file containing the name of the texture (can contain path and must contain extention). For example if some_texture.link contain TFcommon/blue_wall.tga line, then loading some_texture will load blue_wall.tga from the indicated directory. This can eliminate texture duplication and allows meaningful naming of textures.

Skyboxes are supported. Name of skybox should be placed into r_skybox variable or you can use loadsky skyboxname command. Skybox textures have names namexx.* or name_xx.* (where xx: rt, bk, lf, ft, up, dn). Due to some problems with skybox rendering and possible cheating skybox should be allowed on server through 'serverinfo allow_skybox 1'.

32bit texture can be used as crosshair (crosshair 5). Required rexture is loaded by load_crosshair name command. Partial transparency is supported. Size and color are set by cl_crosssize and crosshaircolor cvars.

Sound settings

New variables

Additional command line parameters

Console logging

It is now possible to switch on and off console logging at any desired moment directly from the console. Here are related variables and commands:

The log-file described would have absolutely no connection to that of -condebug key. Moreover, you can writw them both at once :)
Examples:

// starts new log with timestamps
log_prefix "[@date @time]"
log_filename "mycoollog.txt"
log_truncate

// stops logging
log_filename ""

Handling the number of packets sent to server

The Quake engine is constructed in such a way that fps is rigidly connected to the number of packets sent to a server. This means that if you got a bad connection and a low rate number - you will hardly get nice fps. The cl_c2spps variable allows to limit the number of sent-to-server packets. At the same time your fps is defined by cl_maxfps variable. These "extra" packets are put away and the resulting backdrop is often packetloss and loss of some commands. Some solutions for keeping the most important information intact have been introduced but I would not promise heavens.

Example:

cl_maxfps 60
cl_c2spps 30

Changes in file searching algorithm

It is possible to set gamedir at client sartup:

qwcl262 -game fortress

This put fortress directory to the list of directories where files are searched, so files situating there have a priority over files lying in qw and id1. This includes among others quake.rc, autoexec.cfg, gfx.wad, conback.lmp etc.

Small comment on quake.rc: Default quake.rc is included in id1/pak0.pak and contains execution of autoexec.cfg, config.cfg and stuffcmds command, that puts into execution buffer commands that were given in the command line (+connect localhost for example). If you have decided to write your own quake.rc, then you should make these action yourselves if it is required. When launced with -game paramerter and standard quake.rc client looks for autoexec.cfg file first in the given directory that allows automatiñ launching of the required mod config at startup, before connection to any server.

A userdir command can be used for addition of directories to the list searched for files by the client (configs, sounds, models, etc.). Real handy when several players with their own configs files play Quake on a single computer.

It is possible to set userdir at client startup. Then configs will be executed taking this directory into account. One can use -userdir and-game separately or both at once. Example:

qwcl262 -userdir vasya 2 -game fortress

It is possible to use PAK-files with arbitrary names. When the directory is added to the search path first files pak0.pak, pak1.pak are loaded, then pak.lst is read and all the PAK-files listed there are loaded (one per line with extension). GL-âåðñèÿ skips all files strting with "soft", soft-version skips files starting with "gl". If userdir is set to name, then finally name.pak is loaded.

Demo recording and playing

Demo-player is built into the client. You can reach it through multiplayer-demos menu or by the menu_demos command. It is possible to playback directly the qwd, qwz (qizmo compressed format) and mvd (multi view demos - server demos). The .qwz demos are automatically unpacked by qizmo. The unpacked file is deleted after the end of the playback. The qizmo_dir variable ("qizmo" by default) defines the folder in which qizmo surfs (according to quake dir).

Demo recording differs from that of qw2.30. In QW262 the delta-compression is not switched off and this feature reasonably decreases lags. You can now use pause command to pause while viewing a demo.

The beginning of a demo playback is detained till it's actually possible to show it. Helps when something interesting is in the very beginning and you MUST see it.

The playback of demos recorded in spectator mode with cl_chasecam 1 is improved. The player's model is not shown now but you can see proper weapon model.

Other variables connected to demos:

Spectator mode and MVD demos playback

The spectator mode has been greatly improved. mvd demos playback is practically the same as spectating but you can set pause in any moment and switch to any player or move the cam. During camera switching effects of TeanFortress flash and concussion grenades are cleared.

Converting demos to AVI (filming)

To faciliate this process there is a capture command. If you issue capture <fps> command during demo playback, the client starts to make a series of screenshots with the required fps. This mode is switched off by capture 0 command or automatically at demo end. There is NO NEED to worry if your computer is fast enough to write many screenshots. It is possible to write 72 fps in 1600x1200 resolution.Of course it will be slow, but it is possible. And vice versa: if you need only 5 frames per second in 320x200 resolution, then it will be rather fast :) Screenshots are put into directory given by capture_dir variable (realtive to Quake directory, default: "capture"). Subdirectory is created with name @date-@time to prevent accidental overwriting of one series of screenshot by another.

Mini-Gamespy

One can get certain info about Quake servers without being connected to them.

Example:
cl_gamespy_showplayers 1
gamespy quake.orc.ru:27530

Limitation of client capabilities using serverinfo fpd

Client respects some limitations set by the server administration using serverinfo fpd and disable some functions. These bits in fpd are supported:

• 1 - Macros in say are disabled
• 2 - Time variable won't show seconds
• 4 - Triggers are disabled

During connect to server client reports in the consiole if something is disabled.

Message filtering

There is a possibility to filter messages (works with any server but QW262 server makes filtering at server-side thus reducing the network traffic). For a message to be filtered and reach you it must end with #abc, where abc is a name of the channel (must consist of 3 letters!). Messages without a name of a channel are never filtered off. It is possible to assign filtering via several channels. For example, filter "#att#eng" will allow you to obtain messages on #att and #eng channels. At the given moment widely used are only #att and #def channels for attack and defence modes respectively. When a #def filter is active you will not get messages marked differently than #def. In order to totally cancel filtering use a filter "" command.

Improved console

The following buttons and combinations work in the console::

In messagemode, messagemode2, messagemode3 modes the buffer of the foregoing messages is implemented and you can scroll it by UPARROW and DOWNARROW buttons.

-alias are blocked in console so that they do not executed when typing except for the keys that have no function in console (like Fx).

Keyboard

The number of bindable keys has been greatly expanded. It is now possible to bind CAPSLOCK, SCROLLCK, NUMLOCK, PRINTSCR. If a cl_keypad variable is set to 1, then you can bind the buttons of extended keyboard independently, i.e. the DEL and KP_DEL will make a difference. The names of buttons are listed below. Some buttons have several alternative names, so it is possible to use any of them.

Notes:

In Win32 version PRINTSCR won't work if simultaneously CTRL, ALT etc buttons pressed.

Mouse

Mouse wheel works in DirectInput mode if m_forcemwheel cvar is set to 1.

MOUSE4 - MOUSE8 are supported. However driver support is required. It works with Microsoft drivers, does not work with Logitech Mouseware up to version 9.73.

Client has internal support for MOUSE4 - MOUSE8 buttons if Logitech Mouseware is installed (up to version 9.73) (mw_hook.dll library is required!). This mode is turned on by setting m_mwhook cvar to 1, and it does not matter what is mapped in to 4th-8th mouse button in Mouseware itself. If you don't like the default numbers of mouse buttons then you can change it using m_map_button command:

Example: logically swaps 4th and 5th mouse buttons, 6th button become an equivalent of keyboard key 'a' :
m_map_button 4 MOUSE5
m_map_button 5 MOUSE4
m_map_button 6 a

It as possible to use all keys emulated by Logitech Mouseware when mouse button is pressed (not only CTRL and SHIF). However one should know that:

1. m_mwhook 1 mode is more convinient.
2. Button up and down commands arrive without pause between them so you may need wait.
3. They arrive then the mouse button is RELEASED.
4. If you are using cl_keypad 1 then KP_* variants of button are generated for PGDN, PGUP etc.

Advanced scripting

Aliases execution speed was considerably elevated in comparison to QW2.30. The scripting language was widely extended. Command processing buffer was increased to 16K. A special alias 262_quakerc is automatically executed on launching of the client (after quake.rc is loaded), on changing the gamedir alias 262_autoexec is executed after ordinary configs loading. Thus, one can isolate specific part for QW262 config file, so that multiple error messages are not received under QW2.30 which does not understand QW262 scripting.

Variables defined by user (cvar)

Values of variables (both built-in and defined by user) can be used in scripts. Sign @ (or $ if yo have changed cl_prefixchar) must stand before a name of such variable. Cvar expansion is not working for variables inside the dual quotation marks ", with exception of the specially stipulated cases.

Examples:

echo current fov: @fov
register class style
class medic
style att
bind t "say_team (@style-@class) Idu po kiwke"

One should remember one important thing. Script statement parsing and cvar expansion is made up to the end of line or semicolon symbol. So if you need to create a cvar containing semicolon you should create another variable, contatining it. For example:

set _tz ";"
alias example "set tmp a%a,%h@_tzlocation:%l'"
say_team @tmp

One can increase or decrease value of a variable in such way:
fov @+5 - increases fov by 5
fov @-5 - decreases fov by 5

There are some commands introduced to change values of variables:

Examples:
// a = b * 3
set_calc a @b * 3
// len = strlen(str)
set_calc len strlen @str
// a = 7 div 3 = 2
set_calc a 7 div 3
// intvar = int(3.67) = 3
set_calc intvar int 3.67
set a "aaaaaaaaaaa"
set b "bb"
set_calc a set_substr b 4
// a = "aaaabbaaaaa"

// rnd (range)
set tmp @time_format;time_format 0;set_calc rnd_seed @time div 123;time_format @tmp
alias rnd "set_calc rnd_seed @rnd_seed * 106; inc rnd_seed 1283; set_calc rnd_seed @rnd_seed % 6075; set_calc rnd_n %1 * @rnd_seed; set_calc rnd_n @rnd_n div 6075"
rnd 40
echo @rnd_n

// crypt/decrypt
set crypt_key "Crypt algorithm is simple"
set text "Very Secret string!"
echo @text
crypt text @crypt_key
echo @text
crypt text @crypt_key
echo @text

cvarlist command prints a list of all registered variables. Flags in front of variables have the following meanings:

bindlist command prints a list of all bound buttons.

Aliases

Aliases can possess parameters. Before alias execution %1-%9 combinations are substituted with a real parameters passed . %0 is substituted with a line containing all provided parameters. Examples:

alias s "say %0"
s hi all!
alias kick "rcon kick %1"
kick 4327

Commands to manage aliases:

Constructing complex aliases

One can write multiline aliases. If the last character of the line is \ , then the next line is a continuation of that line. Don not forget that the maximum length of one interpreted line can not exceed 1024 charcters.

Sometimes it is necessary to use quotes inside quotes. For example when complex aliases create other aliases. Some variables are introduced to facilitate this process:

Examples:
// automessage for a location of a flag drop:
cl_substsinglequote 1
register v_flagdeath
v_flagdeath "say_team ENEMY FLAG: %d; alias f_death"
alias f_took "say_team I''ve got a flag!; alias f_death '@v_flagdeath'"

cl_substsinglequote 0
cl_stringescape 1
alias f_took "say_team I've got a flag!; alias f_death \"say_team ENEMY FLAG: %d; alias f_death\""

Note that both variants work slightly in different ways, so in the first case it is necessary to introduce one extra variable.

cl_curlybraces 1
if {%1} == {@name} {if @tmp = 1 {alias eee {say ok; say ok2}}\
else {say tmp is not 1}}

Conditional execution of commands

Examples:

register v_reportdeath
v_reportdeath 1
alias f_death "if @v_reportdeath = 1 then say_team I am dead [%d]"

cl_substsinglequote 1
set _tz ";"
if_exists alias f_death "set_alias_str tmp f_death;alias f_death 'play dead.wav@_tz@tmp'" "alias f_death 'play dead.wav'"

Message macros

In case if a cl_parsesay variable equals 1, the macros are substituted is performed in commands say*, echo and set_ex (even inside double quotes).

Symbols @ or $ are used in macros depending on cl_prefixchar.

For the macros of ammunition quantities there are some slier versions avaliable: %c+130 - ammout of cells which you need to get 130; %c-130 - ammount of cells which you have over 130.

Examples:
say_team "@GI'm at position, clear (%a:%h)#def"
say_team "@RHelp to defend flag [%l]"
say_team "@REnemy flag dropped [%d]"
say_team "Need rockets, have only %r"
say_team "Need %c+130 cells to build/upgrade sentrygun!"
say_team "@\@RFULL DEFENCE!@R@:Really :)"
// for hunted and QW262 server
say_to_team red "@\PRESIDENT: Clean the respawn area!"

Ocrana pak

This pack modifies the font utilized in the console. Instead of 4 unused symbols with codes of 0x86-0x89, the bright, well noticeable "lamps" are used. They are handy to use for catching some very important game messages. However, it is not worthwhile to misuse them, the messages must be actually important to use them with "lamps".

loc-files support

Loc-files are lists of special marks on a map created for a player to be able to automatically report his/her locations to teammates. Two types of the loc-files are supported: proxy (as those used by qizmo, NF-proxy, etc.) and QW262 own format. The files of QW262 format are located in the loc directory, while proxy format loc-files remain in the locs directory, so there should be no confusion :). Limits for a quantity of loc-points are removed for both types of loc-formats.

Advantages and backdrops of various loc-file types:

Variables and commands referred to loc-files:

Loc creation

The client has an ability to create loc-files (qw262 format only). Please note that currently there are two ways for setting message of loc-block: 1. using index in the "msg" table, 2. using direct "name" variant. Here are some commands to edit loc-files.

In short, a loc-file represents a sequence of special commands which upon loading of a map create appropriate data structures. Frankly speaking, loc-files of QW262 format are simply executed by the exec command, so it is possible for player to put inside loc-files some other commands.

For symmetrical maps (such as most of TeamFortress maps, by the way) it is enough to mark a half (or even a quoter) of a map followed by duplicating it with the loc_mirror command. Example:
// keep2 :)
mark center 0 0
loc_point -61 44 2 -44 61 25 "@blue tower"
loc_mirror xy blue red
loc_mirror x blue yell
loc_mirror y blue green

A cvar expansion is performed in loc-file messages. This should allow to construct more universal loc-files. For example it is possible to set red, blue variables to "our", "enemy" or even to empty string to save message length.

Triggers

In case when cl_triggers variable is not set to 0, the client automatically executes following aliases (if they are defined):

Example:
alias f_death say_team "@YI'm dead [%d]#def"

It is possible to create triggers reacting at userinfo change:

Example:
cl_setinfo_triggers "rate"
alias f_setinfo_rate "if %2 > 5000 then say %1: your rate is set to %2. Decrease rate to 5000!"

regexp triggers

A new possibility is built-in to automatically carry out some actions (aliases) upon detecting a specific message in console or centerprint.

regexp defines which messages (or whatever) will activate a trigger. The client uses the PCRE library (Perl-compatible regular expression library). You can find information how to write regexps in the PCRE's documentation.

A trigger is activated as soon as a string defined in this regexp is detected. At the same time a part of this string (which caused activation of a trigger) is put into a @0 variable. Variable parts of regexp are put into @1, @2 ... @9 variables. After that an alias (which name coinsides with the a name of the trigger) is executed. Tricky, huh? ;)

Commands related to regexp triggers:

A re_trigger_options command has the following options:

In order to bring down possible cheating the list of commands avaliable in trigger-activated aliases was specially limited. It is allowed to use triggers for launching config files, cvar operatons, alias execution and the following commands:

play playvol stopsound say say_team say_id sayid say_to_team echo alias unalias re_trigger re_trigger_options re_trigger_delete re_trigger_enable re_trigger_disable re_trigger_match hud_add hud_position hud_width hud_remove hud_bg hud_enable hud_disable hud_move hud_bringtofront bind record stop register unregister set (and all its variants) inc toggle rcon users user if/then/else if_exists exec

While in TeamFortress you are permitted to use also an impulse command with following parameters: 23(flaginfo), 99(changeclass), 101-109(changeclass commands), 135(inv), 144 (showclasses), 145(showscores).

Examples:
// Setting detpack
re_trigger dp "^Setting detpack for (.+) seconds"
re_trigger_options dp final remove mask 4
alias dp "say_team Detpack for @1 seconds at %l"

// removes spam from inv command output
re_trigger inv_spam "(^You\Dre in team|\w+ armor|^Skin \:|^Colors \:|^Scanner|^$)"
re_trigger_options inv_spam final remove nolog mask 4 noaction

// result of id command is put into @last_id_nick cvar
register last_id_nick
re_trigger postid "(?m)\n\n\n\n(.+)\n(Friendly)"
re_trigger_options postid final mask 16
alias postid "last_id_nick @1"

Important note!
Triggers would not work for debugging messages like snd_show 1. In Team Fortress triggers would not work for commands showloc and id (of enemy), and for message of your dispencer being used by enemies.

Commands alias, unalias, viewalias, cmdlist, cvarlist, unregister, hud_list, re_trigger, re_trigger_enable, re_trigger_disable, re_trigger_delete, hud_enable, hud_disable, hud_move, hud_bg hud_width and hud_remove understand regexps as parameters. Corresponding operation will work on objects that have name matching the regexp. Example:
//list of variables starting with vid_
cvarlist "^vid_"
//removing all variables ending with _test
unregister "_test$"
//list of aliases containing gren1 or gren2 in name
alias "gren(1|2)"

Customizable hud

A user now can easily configure on-screen info he or she wants to be displayed during the gameplay. Hud consists of separate elements any of which can be independently dispatched in any position of the screen .

Hud commands are:

Examples:

// fps counter in lower right corner like show_fps 1
hud_add fps std fps
hud_position fps 3 0 0

// class cvar above lower left corner
hud_add class cvar class
hud_position class 4 0 3

// mapname and time at the lower central position
hud_add test str "@mapname-@time"
hud_position test 6 0 0

// turning huds on and off
alias +scores "cl_hud 0;+showscores"
alias -scores "cl_hud 1;-showscores"
bind TAB +scores

QW262

While playing on a QW262 server clients gain some extra abilities:

Example:

uid lamer
sayid "You are LAME!"
// hunted
say_to_team red "Please remove sniper near respawn"

What is different in QW262 lite server from standard qwsv 2.30

QW262 server for Win32 automatically sets itself as a high priority task (HIGH_PRIORITY_CLASS). This is necessary for avoiding high PL when playing on localhost under Windows9x. If you desire to turn this feature off, launch the server with -nopriority command-line parameter. By the way, the reason for high ping (when QW2.30 server is running under Windows9x) was eliminated. Server uses 32 Megabytes of memory by default.

In order to reduce network traffic server performs message filtering, according to filter variables set by players in userinfo.

Server includes support for TeamFortress flash grenade that can not be disabled by cheaters. If TeamFortress QuakeC code is modified accordingly then flashed client won't get entities updates from server, so players and other objects will dissapear for some time :)

Server has several catgories of rcon. Those who have ordinary rcon_password can not change several server settings (serverinfo, localinfo, gamedir), use rcon say and turn off rcon logging. Administrator password that allows to use any commands is set by master_password command. This command is accepted only from server.cfg

Server-side demos support (Multi View Demos: MVD)

It is possible to write server-side demo. It contain all players actions. Attention: maximum number of entities tha coul be written into MVD demo is increased up to 300 (QW Extended aka mvdsv - 196). Some TF-maps have a lot of entities and some of them simply are not recorded in the demo. If some demo really contain more than 196 entities, it will be played correctly only by QW262 client.

Differences of the full version of server

QW262 server in full version works on the changed protocol. Sources of the protocol are closed, so only a QW262 full version clients can connect to such server. All proxies with built-in cheats are also out of the game. By default the client is working on a QW 2.30 compatible protocol. To connect a QW262 full server one has to use a version command in the console or launch the client with a -ver262 command line parameter.

QW262 full version server has an ability to check players' models and skins to prevent them from cheating. Clients with wrong models and skins are disconnected. Here are corresponding server commands:

It is possible to automatically make a screenshot and download it from any client to check him for cheating.

Who wrote all this madness?! ;)

Original sources (c) Id software
Coding of following people was used:
-=MD=- (Alexander Pouchkov),
Tonik (Anton Gavrilov, tonik@vipmail.ru, ZQuake),
HighlandeR (Bartlomiej Rychtarski , highlander@gracz.net, QW Extended),
Sergio (k_sergio@nm.ru)
5AT0H (5AT0H@aport.ru)
don (don@sztaki.hu, surmoclient)
Vic (Victor Luchits, vic@captured.com)
fuh (A. Nourai, fuhquake@hotmail.com, FuhQuake.
Azazello , MQWCL

Currently, QW262 is being developed by [2WP]BorisU
(Boris Usievich, borisu@newmail.ru).

WAZZUP??

To download the most fresh version, complain about bugs, grab some scripts and ask for implementation of new features - proceed to QW262 homepage.

Partial manual translation by Bruttoid aka Baxta (brutt01d@by.ru).
"This manual could be translated to english only with help of Grazer Spatzen music :))"

Documentation is last updated 29.12.2002 10:16 PM