Optimized .exe; builds of ioq3 engine

News:

In-Game Voice (VoIP) support for servers that support it (/cl_voip 1; ioq3 server: /sv_voip 1). Full instructions are here. Bind a key to +voiprecord to talk, '/voip muteall' to mute all. It requires OpenAL and a high /rate.
Raw Mouse Motion (High-Definition) and Raw Mouse Keys support: in_rawmouse 1; it also eliminates cases of negative acceleration.
'bumpy' renderer, dmaEX 'Surround' audio on all OSes

This project replaces only the .exe of urban terror with a latest version of ioq3 engine, optimized and enriched with several new features and fixes. It does not require q3 and is compatible for online play.

Notable features:

Raw Mouse Motion (High-Definition) and Raw Mouse Keys support: in_rawmouse 1; it also eliminates cases of negative acceleration.
"bumpy" renderer with VBOs, Bump mapping, GLSL, Bloom, Depth of Field Blur, Fog, Fancy Water, Improved Decal Code, and more. Faster than vanilla q3 renderer on r_simpleshaders 1 (set by default for performance; 0 to get its effects).
Several Surround even on Stereo Headphones Systems (Hear audio coming from the back differently):
- dmaEX audio with low CPU consumption (the default; s_useopenal 0, s_useikalizer 0)
- OpenAL with OpenAL-Soft library or a hardware implementation (s_useopenal 1 and appropriate library). It is also required by VoIP.
- iKALiZER: the most fully featured but Win32 only (s_useikalizer 1, s_useopenal 0)
Funstuff, Radio Audio and part of other audio are pre-Loaded to avoid potential freezes of FPS (shown with blank gaps on lag meter). This was a q3-wide UrT issue that applied when someone else joins the game or funstuff is set on the fly, or when some audio files are heard for the 1st time. [Bug reports: 1, 2]
Mumble Positional Audio (hear others in '3D') - 'to use it, start Mumble before you start ioq3, and run the game with +set cl_useMumble 1' [more info at mumble]
An important issue of dropping audio on auto firing is fixed (it was giving the illusion of lower firing rate); it affected Base and dmaEX audio and it can be tuned with /s_smpRepeat.
In-Game Voice (VoIP) support for servers that support it (/cl_voip 1; ioq3 server: /sv_voip 1). Full instructions are here. Bind a key to +voiprecord to talk, '/voip muteall' to mute all. It requires OpenAL and a high /rate.
Meters with stats for Ping, FPS, Snaps and Packets
Quiet console; avoid seeing the same technical messages over and over when map changes.
/zoomsensitivity; avoid scripts by using a direct multiplier on your normal sensitivity only when zoomed. e.g. /zoomsensitivity 1.5 means sensitivity x 1.5
autotimenudge: set timenudge automatically - experimental feature - do not use when spectacting or right after round change - see notes below
Anaglyph rendering with 3D glasses
/sysexec, execute an external program (in the path or using full path). This can be used to control external applications via controller utilities.
/totaltimerun - report the total time the client has run since its internal var was first saved plus the time run for current session.
Stopwatch of millisecond accuracy
'server is full and server is for low pings /reconnect' workaround; plus no need to wait to hit /reconnect on a 'server is full' that may erroneously report 'for low pings'. [Bug report: 1]
SDL system for accessing input, graphics and audio hardware; this may improve use of mice keys and access to other input, audio and video hardware.
Alarm mechanism on clock
Built on recent compilers
Blank the screen temporarily with +blank (/bind x +blank)
/rebind: bind a key to a cvar and its current value. Useful for making gear-sets binds on the fly during gaming.
Win64 binary support first developed for this client [with actual qvm compilation]

Downloads:

List of files at its project page.

Instructions:

Unzip files into urt's .exe folder
Run ioq3-urt.exe
(one can rename it to ioUrbanTerror.exe for convenience with other programs, though this is not a version of iourt, it only acts like it partly)

Notable features in detail:

ConsoleVars added (click 'Show' to view; dmaEX, iKALiZER, Bumpy and new ioquake3's vars are not included):

Spoiler

//<variable or bind>              <default value or command>           <description>
in_rawmouse                       "1"                                  //Use Raw Mouse Motion (High-Definition) and Raw Mouse Keys 

s_smpRepeat                       "16"                                 //Sample Repeat limit; increased from the equivalent hardcoded 
                                                                       //default of vanilla of 4. It fixes severe issues of audio samples 
                                                                       //dropping (e.g. on auto firing). Base or dmaEX related only.

//bind x                          sysexec                              //execute an external program which is in the path or using full path

zoomsensitivity                   "1"                                  // sensitivity * <multiplier> only when zoomed
cl_zoomsensitivityfovthreshhold   "90"                                 // internal. fov below which zooming is considered  to occur

cl_quiet                          "1"                                  // remove technical messages, especially on map change
cl_quietuglyhack                  "1"                                  // remove even more stemming from the game code - requires cl_quiet

//bind KEY                        totaltimerun                         // print total time run since cl_totaltimerunsave was first saved, plus total time run for current session
                                                                       // no need to bind it. 

cl_totaltimerunsave               "0"                                  // internal. save total time run in seconds up to 32bit unsigned (136.2 years).
                                                                       // it can only be altered manually on the config

cl_aviMotionJpegQuality           "90"                                 //jpeg quality when cl_aviMotionJpeg is on
r_screenshotJPEGQuality           "90"                                 //similarly for /screenshotJPEG

net_dynamicport                   "1"                                  //Randomize the port of the client each start to workaround the 'same IP issue' on NAT LANs.

r_windowPosition                  "0,0"                                // comma separated window position when r_centerWindow 0. It's mostly usefull when
                                                                       // r_noborder is 1 since in that case taskbars can be accommodated. It's ignored when
                                                                       // r_noborder is 0 + it's on "0,0" to not be messing with 'draggability'.


//////////////////
//*experimental* auto-timenudge 
//bind KEY                        autotimenudge                        // On-demand auto-timenudge - do not use right after round change or when spectating
cl_autotimenudge                  "1"                                  // turn on collection of autotimenudge data, very minimal gain if off
cl_autotimenudgeinterval          "1"                                  // interval in secs for calculation of standard deviation 
cl_autotimenudgecommand           "ut_timenudge"                       // game's command for timenudge

cl_autotimenudgelive              "0"                                  // live autotimenudge - *VERY* experimental: expect hell on round change
                                                                       // or spectating, plus it periodically causes config write
                                                                       // may be bearable on non-round-based gametypes.
cl_autotimenudgefloodprotsec      "5"                                  // flood protection seconds for live autotimenudge
/////////////////

cl_drawmouse                      "1"                                  //draw mouse stats
cl_drawmouseinterval              "0.08"                               //interval it waits to calculate
cl_drawmouseposx                  "0"                                  //pos x on screem
cl_drawmouseposy                  "3"                                  //
cl_drawmousesize                  "7"                                  //font size

//bind KEY                        minimize                             //explicitly minimize; fixes a gamma bug with alt+tab since alt+tab's real job is not to minimize but to bring up a list.
cl_alttabminimize                 "1"                                  //0 to remove SDL's explicit minimize on alt+tab

cl_nologo                         "0"                                  // don't show the logo video (off by default). the 'normal' "+nosplash on shortcut" way
                                                                       // was only a workaround, +nosplash doesn't really exist, any +whatever would stop it

cl_recordfontsize                 "8"                                  // recording notification font size. 0 will disable the notification so be careful.

cl_drawclockcolor                 "8"                                  // color of clock
cl_drawclockfontsize              "6"                                  // size of clock
cl_drawclock12                    "1"                                  // 24 or 12h clock
cl_drawclockshowseconds           "0"                                  // seconds on/off
cl_drawclockposx                  "2"                                  // position of clock on the screen X dimension
cl_drawclockposy                  "42"                                 // position of clock on the screen Y dimension

cl_drawclockalarm24               "0"                                  // Turn on the alarm clock in HH:MM in 24h format
cl_drawclockalarmcmd              "play music/mainmenu"                // alarm clock command. what happens when alarm goes off


//bind KEY                        cl_utradio                           // Print radio commands available - no need to bind it

//bind KEY                        rebind                               // bind a key to a cvar and its current value
                                                                       // e.g. /rebind F9 gear" sets F9 to "gear XXXXX"

cl_stopwatch                      "0"                                  // Stopwatch On/Off
//bind KEY                        cl_stopwatchstartpause               // Stopwatch Start/Pause - Bind it to a key
//bind KEY                        cl_stopwatchreset                    // Stopwatch Reset - Bind it to a key
cl_stopwatchposx                  "8"                                  // Stopwatch Position X
cl_stopwatchposy                  "23"                                 // Stopwatch Position Y
cl_stopwatchsize                  "12"                                 // Stopwatch Size

cl_drawping                       "0"                                  // Ping Statistics On/Off
cl_drawpingfontsize               "7"                                  // Ping Font size
cl_drawpingfirstinterval          "2"                                  // Ping First Interval - collect info for <seconds>
cl_drawpingsecondinterval         "10"                                 // Ping Second Interval
cl_drawpingposx                   "0"                                  // Ping Position X
cl_drawpingposy                   "14"                                 // Ping Position Y

cl_drawfps                        "0"                                  // FPS Stats On/Off
cl_drawfpsfontsize                "7"                                  // FPS Font size
cl_drawfpsfirstinterval           "2"                                  // FPS First Interval
cl_drawfpssecondinterval          "10"                                 // FPS Second Interval
cl_drawfpsposx                    "0"                                  // FPS Position X
cl_drawfpsposy                    "11"                                 // FPS Position Y

cl_drawpackets                    "0"                                  // Client Packets per Second Stats On/Off
cl_drawpacketsfontsize            "7"                                  // PPS Font size
cl_drawpacketsfirstinterval       "2"                                  // PPS First Interval
cl_drawpacketssecondtinterval     "10"                                 // PPS Second Interval
cl_drawpacketsposx                "16"                                 // PPS Position X
cl_drawpacketsposy                "2"                                  // PPS Position Y

cl_drawsnaps                      "0"                                  // Server Snaps per second Stats On/Off
cl_drawsnapsfontsize              "7"                                  // SPS Font size
cl_drawsnapsfirstinterval         "2"                                  // SPS First Interval
cl_drawsnapssecondinterval        "10"                                 // SPS Second Interval
cl_drawsnapsposx                  "0"                                  // SPS Position X
cl_drawsnapsposy                  "7"                                  // SPS Position Y

//bind KEY                        +blank                               // Blanks rendering while it's pressed + turns off 2D at the time
r_blankrgb                        "0 0 0 0"                            // Blanking color in 0-255 R, G, B and 0-1 alpha
r_blank                           "0"                                  // Internal: manually blank rendering, 2D is not turned off

Raw Mouse Motion (High-Definition) and Raw Mouse Keys: in_rawmouse 1: It utilizes raw input in accordance with a Microsoft advisory. The main advantages are higher resolution support and the the elimination of cases of negative acceleration. With in_mouse -1/in_rawmouse 0, negative acceleration can occur since an internal desktop cursor is utilized which may produce the quirk if it hits the edge of the window before it recenters. Also, since the virtual cursor only sends signals when it moves, it is lower resolution/higher latency in certain cases. On in_mouse 1/in_rawmouse 0 (DirectInput) there's no negative acceleration attributed to software or lower resolution but there are higher latencies involved (also according to microsoft). The functionality is live, meaning in_rawmouse's value takes effect immediately in game. The API is not always stable so in certain systems it might be better to revert to an old system.
Full info on the "bumpy" Renderer by Peter "TwentySeven" McNeill is in its thread. Porting was greatly helped by QA member undead. r_simpleshaders is 1 by default for performance, set it to 0 for its effects. Features such as fancy water or full bump mapping have to be supported by the map or override a map's shaders. e.g. try ut4_moonbase for fancy water examples. It may require newer GPU hardware or more RAM than before. It is still relatively unstable. BSP processing duration is expected to be increased.
Surround even on Stereo Headphones Systems (Hear audio coming from the back differently):
- dmaEX audio is developed by p5yc0runn3r and more info on it and its operation is in its thread. It provides a "Surround" Hybrid-HRTF/DPL2 experience on all Operating Systems on stereo. "It [extends the base q3 audio with] 360 degrees sound virtualization, sound interpolation and increases output rate to 44Khz. At 22Khz the mixer is the same speed as the base system while at 44Khz the CPU usage is minimal." s_useopenal and s_useikalizer should be set to 0 to use it. See more info and vars in its thread. Its CPU impact is marginal, hence it's on by default. To revert it to vanilla system set dmaEX_effectsenable to 0 and s_sdlspeed to 22050 and restart game.
- OpenAL is an API with several software and hardware outcomes which is also required by in-game VoIP support. OpenAL-Soft is a software implementation which offers basic Binaural experience. The API also provides a framework for card manufacturers to support their audio features on hardware. Audio cards that have OpenAL support on their drivers (such as Creative, Nvidia, and Realtek's) can provide forms of "Surround Headphone sound" or Surround Speakers setups (via methods such as HRTFs, Dolby 5.1 Simulation, CMSS-3D, 5.1/7.1 Speakers etc.). The system needs an appropriate library (e.g. an OpenAL32.dll) available such as OpenAL-Soft for basic software binaural audio, Creative's basic OpenAL libraries, or a manufacturer's hardware supporting libraries.
- iKALiZER is the most fully featured but it can have the most CPU impact - though mainly on old systems and single core CPUs - hence it has to be enabled manually with s_useikalizer 1. It is developed by Christophe Gossa and more information is in its thread. Headphone HRTF mode is enabled by default (other modes are available (such as 5.1 or holographic headphones, see /ikalizer_channelmode) but this should be the main needed by most gamers). If you need its replacement sounds (nades sound great), download the 20MB file (from its thread) and place only q3ut4\iqs dir in %appdata%\Quake3\q3ut4 (not in .exe dir\q3ut4). If OpenAL was enabled, it has to be disabled with s_useopenal 0 before using this; /s_info should report which sound system is in use.
A base audio (and by inheritance dmaEX) issue involving dropped sounds when attempting to play them simultaneously, is tackled with tuning it with the /s_smpRepeat client var. It effectively allows a higher limit for simultaneous playback of the same sample. This solves the issue of having dropped sounds e.g. when auto firing a G36 or M4 which was giving the illusion that rate of fire was lowered (while only the audio that was heard was erratic). The issue was apparent on all clients and systems though it is less pronounced on older versions of ioquake3 (such as the one on iourt). The new var's default limit of 16 is 4 times higher than the hardcoded vanilla one. There is a minimum limit of 8 since the previous one (4) was effectively buggy. Examples: in a quiet environment, auto firing a LR300 now can lose sounds only on timescale 3 or 4 when using the minimum allowable of 8. On the default of 16 or higher it's virtually impossible. Notice the limit is internally doubled for sounds originating from the Listener (like the aforementioned firing examples). It doesn't affect CPU load; such a process existed to begin with possibly for avoiding spamming of sounds that fill up all channels due to map or gameplay quirks.
Concerning VoIP, notice that cl_voip is 0 by default and if it's enabled the console will be slightly spammy about its requirements, i.e. "I need OpenAL" and "I need high /rate" (in bright yellow) if they're not available. If it's initialized reasonably, i.e. it got a recording device on OpenAL, it will print '* VoIP is initialized'.
/totaltimerun - report the total time the client has run since its internal var was first saved (cl_totaltimerunsave), plus the time run for current session. (up to 136.2 years).
Anaglyph rendering (with 3D glasses)

It is available in the latest ioq3 versions; detailed information on its use is here (lengthy details on its operation and vars here). Notice that it may need /r_anaglyphMode (e.g. 1) and not r_stereoEnabled which may require special hardware or not be functional yet. I tested it on a common pair of red/cyan glasses but that may not be an ideal mode.
Stopwatch (millisecond accuracy)

use /cl_stopwatch 1 to show it; bind a key to cl_stopwatchstartpause to start/pause it; cl_stopwatchreset to zero it. Similarly with the meters described below, its position can change with cl_stopwatchposx/y and its size with cl_stopwatchsize. It supports /timescale.
Auto-timenudge is an experimental feature (do not use when spectacting or right after round change):

It attempts to set timenudge based on the standard deviation of ping, e.g. 5 to 14 standard deviation attempts to set timenudge to 10. /autotimenudge attempts to set it on-demand according to the collected data. A very experimental feature is cl_autotimenudgelive which attempts to do it periodically automatically; it is very quirky since hell may commence after round-change or when spectating since at that time ping data is unreliable or nonsensical (however, it may be bearable on non-round-based gametypes). Another undesireable behavior is that config is updated each time though on the on-demand version this can be considered normal. Other cvars incluce cl_autotimenudgecommand for setting the timenudge command of the game (ut_timenudge on urt), cl_autotimenudgeinterval for the interval it collects data to calculate standard deviation and cl_autotimenudgefloodprotsec for setting flood protection delay in the case of live. cl_drawping described below can be used to observe standard deviation directly according to certain intervals (data are not connected between them).
Detailed Meters: cl_drawping, cl_drawfps, cl_drawpackets and cl_drawsnaps:

They show base value of Ping, FPS, Snapshots per second (from server to gamer) or Packets per second (from gamer to server); there is also mean value for two intervals (in seconds) set by the user via vars. There is max spike or drop of those values in the intervals set as well as mean spike or drop and most importantly, standard deviation. Standard deviation shows in general 'the common difference of most values from the mean'. This means it's a very good approximation of stability in a single number. A (direct) use of it might be to set ut_timenudge according to the standard deviation of ping but that may be debatable. Their size can change, their position can change too according to vars you can easily find out by typing the vars and hitting tab (to not flood this page unnecessarily). In the case of snaps/sec delayed packets are also shown, referring to those throttled by rate/sv_maxrate and extrapolated ones (which may have a different meaning from extrapolation shown on net meter); the packets/per second meter (client->server) demonstrates how depended is cl_maxpackets on FPS.
- Similarly, /cl_drawmouse (updates/sec, dots/sec, total dots for an interval and max dots; similar cvars with other meters)
cl_drawclock has an alarm mechanism, it can be a 12h clock on choice and it can be set whether to show seconds.

cl_drawclockshowseconds shows seconds (off by default); cl_drawclock12 makes it become a 12h clock and cl_drawclockalarm24 can set its alarm time in the form of HH:MM (in 24h format). It alarms (by default) by playing the main urt audio theme. The alarm command (what happens when alarm time comes) can change with cl_drawclockalarmcmd (e.g. it can quit the client on alarm if set to 'quit'). It is not in operation when clock isn't shown to save cpu cycles (granted, it has minuscule importance but the principle of optimization stands) and it's not in operation when not in a map. Positional vars are similar to meters'; cl_drawclockcolor alters the main clock's color.
Recording notification has been modified to only show the first 10 characters of the filename to not flood the screen (similarly to iourt); cl_recordfontsize will change its font size; 0 will disable the notification so be careful.
config files, demos, screenshots, and videos. are auto-saved in %appdata%\Quake3\q3ut4 to allow for multiple users and to avoid security system issues on Vista/7 (%appdata% is a shortcut to <drive>\Users\<Username>\AppData\Roaming in Vista/7 or <drive>\Documents and Settings\<user name>\Application Data in XP). An autoexec or a demo already in the old location still works fine. The priority is "read %appdata% first, app dir second; if a cfg appears in both, only read the one in %appdata%". The autogenerated q3config is being saved in %appdata%. "You can revert to the old single-user behaviour by setting the fs_homepath cvar to the directory where the game executable is located. For example: ioq3-urt.exe +set fs_homepath "c:\UrT" Note that this cvar MUST be set as a command line parameter [e.g. in the shortcut or qtracker parameters]."
Mouse keys for Logitech and potentially other mice can be differently mapped here - even on the same filename - because ioq3 uses the SDL library to access input. The good news is that previously disabled keys may now work.
The mess of technical messages each time a map changes is removed with cl_quiet; On by default. Some messages that are controlled by the game code (and not engine code fully accessed by this) are removed with an ugly hack via ..cl_quietuglyhack.
/minimize (also on a bind) explicitly minimizes the client, plus alt+tab explicitly directs SDL to minimize it (rather than relying on the windows manager). Use of /minimize can fix a gamma bug that may appear on windows if one minimizes it with alt+tab (since alt+tab's real job is to bring up a list, not to minimize).
cmd buffer has been increased to support larger config files (of 128KB)
an interesting support feature from ioq3 is that in case of crash, the game presents the user with a choice to start with safe settings (e.g. video resolution).
a +vstr bug (involving locking of key-down event in the case of using a second +vstr bind) has been workarounded. [Bug report: 1]
/rebind can work as follows: If F5 is bound to "rebind F9 gear" then hitting F5 during gaming will set F9 to "gear XXXXX". Useful for setting gear-sets binds on the fly during gaming (when not knowing what sets will be used when making scripts).
cl_aviMotionJpegQuality can adjust the quality of JPEG when cl_aviMotionJpeg is on. Similarly, r_screenshotJPEGQuality can do the same for /screenshotJPEG.