UDT - Uber Demo Tools
UDT is a set of tools for analyzing, cutting, converting, modifying and viewing Quake 3 and Quake Live demo files.
The main features are:
- Extracting and displaying information (examples: map name, player names and teams, game mode, etc)
- Cutting by time: creating a new demo file that is a time sub-range of the original demo file for easier processing or demo viewing
- Splitting demos: given a demo with multiple gamestates (happens on map change/reload), create a new demo file per gamestate
- Cutting by patterns: given rules defined by the user, find matching events and cut demos around the times of said events
- Searching for patterns: given rules defined by the user, find matching events and display the results with the option to apply cuts later
- Time-shifting demos: shifting the non-first-person players back in time (a sort of anti-lag)
- Merging demos: given multiple demos from the same match recorded by different players, create a new demo with more complete information
- Converting demos: convert demos to a different protocol version
- Viewing demos with the 2D demo viewer (top-down view)
Permanent links to the latest builds
|OS||GUI||Command-Line Tools||2D Viewer|
|Windows||x64 - x86||x64 - x86||x64 - x86|
|Linux||Not Available||x64 - x86||x64 - x86|
Alternatively, you can browse this folder where you can also find older releases.
The zip files are Windows releases.
The tar.bz2 files are Linux releases.
The project is currently comprised of 4 parts:
- A shared library,
UDT_DLL, with a C89 compatible interface, written in C++. Supported OSes: Windows, Linux
- A set of command-line tools, written in C++. Supported OSes: Windows, Linux
- A GUI application,
UDT_GUI, written in C#. Supported OSes: Windows only (requires the .NET Framework)
- A 2D demo viewer,
UDT_viewer, written in C++. Supported OSes: Windows, Linux
Overview of the binaries
|Windows Linux||Shared library that does the actual cutting and analysis work|
|Windows Linux||Command-line application for cutting demos by time, chat patterns (Cut by Chat) or matches (Cut by Match)|
|Windows Linux||Command-line application for splitting demos with at least one map change into individual demos with no map changes|
|Windows Linux||Command-line application for shifting the non-first-person players back in time (a sort of anti-lag)|
|Windows Linux||Command-line application for merging multiple demos into one|
|Windows Linux||Command-line application for exporting analysis data to JSON files (one per demo file)|
|Windows Linux||Command-line application for exporting a sorted list of all flag captures from the demo recorder to a single JSON file|
|Windows Linux||Command-line application for converting demos to a different protocol version|
|Windows||.NET Framework 4.0 Client Profile||GUI application for demo analysis, information display, cutting by time or various patterns, time-shifting, merging, conversions, etc|
|A 2D demo viewer that can generate heat maps|
Read-only demos can be analyzed.
Read/write demos can be analyzed, modified and cut.
|File extension||Game version||Support level|
|dm3||Quake 3 1.11-1.17||Read-only|
|dm_48||Quake 3 1.27||Read-only|
|dm_66||Quake 3 1.29-1.30||Read/write|
|dm_67||Quake 3 1.31||Read/write|
|dm_68||Quake 3 1.32||Read/write|
No installation is required for any of the binaries.
The command-line tools have no third-party dependencies.
For Windows users:
UDT_viewer need to be able to read and write to config files right next to them.
It is therefore recommended to put all the binaries in a new folder with read and write access (i.e. not in
Program Files nor
Program Files (x86)).
UDT_GUI requires .NET Framework 4.0 Client Profile at a minimum to run.
If you have Windows 8 or later, then you should have it pre-installed with the OS unless you changed system settings.
UDT_viewer requires Direct3D 11 on Windows and GLFW 3 on Linux.
When I started work on my first fragmovie, I had a bunch of properly sorted and named demos with cool frags but I realized I had a lot more cool frags scattered among a huge amount of demo files.
Those others demos were not renamed (time-stamp, type of frags) nor sorted. I was definitely not going to watch them, so I had to find another way.
Whenever I had made a cool frag, I was using the same exact chat message every time because I had a chat bind for said message, so all I did was press a key. I then realized that the chat message is a marker for cool frags. If I could find when those messages were printed, I could find the cool frags! Thus, the first
Cut by Pattern feature was born:
Cut by Chat.
Typical GUI Usage Scenario
The typical day-to-day usage scenario for UDT is the one for which the interface has been optimized:
Cut by Chat.
It supposes the following:
- You have a chat bind you use when you make cool frags or something funny/unusual/movie-worthy happens. Example: you have
bind space "say HAHA! YOU ARE DEAD!"in your Quake config and you press space when something cool happens.
- You have configured UDT's
Chatrules under the
Patternstab and the general stuff under the
After your gaming session...
- Drag'n'drop the new demos onto UDT.
- Select all demos (can click the
Demo Listlist box and press Ctrl+A), then click click
- You now have a cut demo for each cool thing that happened in the folder you specified.
- Review the cut demos to decide what you keep, rename and move those you wish to keep to the appropriate folder.
With that workflow, you minimize the amount of work needed to find and keep what's worthy after your play sessions. Less work for the players, more cool stuff for the movie-makers.
- All timestamps in UDT are server times, not match or warm-up times. The time you see on the Quake "clock" is not the server time.
- The syntax
$(x)means format the variable
xinto a string.
- The syntax
$02(x)means format the variable
xwith with at least 2 digits (add leading zeroes if necessary to get 2 digits).
- The time format used everywhere in the GUI for read-only data is
- The time formats accepted for input ate
$(total_seconds). Any amount of leading zeroes is acceptable. Example: "107" is the same as "1:47".
- For file names, the format is
:in file names is not valid. Example: time "1:07" becomes "107".
- In other words, the last 2 digits of a file name timestamp are always the seconds while the ones prior are the minutes.
Here are the patterns you can look for in demos:
|Chat||All||String patterns in chat messages|
|Frag sequences||Selected||Sequences of frags happening within a certain duration|
|Mid-air frags||Selected||Rocket and BFG frags where the victim was airborne|
|Multi-frag rails||Selected||Railgun frags killing 2 or more players|
|Flag captures||Selected||Flag runs: the player picks up the flag and captures it|
|Flick rails||Selected||Railgun frags where the attacker's view angles changed very fast right before the killing shot|
|Matches||None||Each match, from pre-match count-down start to post-match intermission (scoreboard screen) end|
- To which player(s) is the pattern matching applied to?
Selected— see the
Player Selectionrules in the
Maximum Thread Count
UDT GUI and most of the command-line tools expose a
Maximum Thread Count option which, as the name implies, only acts as an upper bound.
The actual thread count used by UDT for processing a job is based on the number of files, total byte count, CPU core count and the
Maximum Thread Count the user specified.
Please note that given the way UDT works, augmenting the thread count will only yield a performance increase when reading the demos from an SSD.
If you have a standard hard drive and not an SSD, make sure to leave the
Maximum Thread Count to 1.
Here are the throughputs (in MB/s), for each thread count, when parsing with all analyzers enabled:
- Intel Core i7 2600K CPU (4 cores) + Intel X25-M SSD
- Intel Core i7 3770K CPU (4 cores) + Samsung 850 EVO SSD
- Intel Core i7 5960X CPU (8 cores) + Samsung 850 EVO SSD
- The SSD seems to freeze for a bit thus slowing things down
Build date: April 18, 2016.
While the performance increase isn't perfectly linear, the benefits are far from negligible for users with SSDs.
The technical notes have their own page here.
Building from Source
The guide for all supported OS and compiler combinations is here.
Custom Parsing API
The developer's guide to the custom parsing API is here.
myT @ QuakeNet on IRC
myT @ ESR
Official ESR forum thread: UDT @ ESR
No account is required to post comments.
In alphabetical order:
The entire source code in this release is covered by the GPL.
See COPYING.txt for the GNU GENERAL PUBLIC LICENSE.
Uber Demo Tools (UDT) is Copyright (C) 2011-2016 Gian 'myT' Schellenbaum.
It is based on the Quake III Arena source code and the Challenge Quake 3 source code.
The Quake III Arena source code is Copyright (C) 1999-2005 Id Software, Inc.
The Challenge Quake 3 source code is Copyright (C) 2006-2009 Kevin H 'arQon' Blenkinsopp.