mDd client Proxymod

This proxymod helps players to train their abilities in the Quake III Arena modification DeFRaG. It adds hud elements to the standard defrag hud.

Installation

Quick and easy:

1. Find the right cgame platform specific binary in the latest release. To know which binary to choose, run \version in your engine's console. This will tell you Windows vs Linux vs macOS and 32-bit vs 64-bit.

	Windows	Linux	macOS
32-bit	cgamex86.dll	cgamei386.so
64-bit	cgamex86_64.dll	cgamex86_64.so	cgamex86_64.dylib

2. Download and copy this binary into the defrag folder of your Quake III Arena directory.
3. Put seta vm_cgame 0 in your config file (e.g. defrag/autoexec.cfg).

You've correctly installed the proxymod if you load your favorite map and you see the following colored text in the console: [mDd] cgame-proxy X.X.X.

Changelog

Please see CHANGELOG for notable changes between releases.

Configuration

All commands and cvars start with mdd_ and can be listed by typing this prefix in the console followed by pressing the tab key. Information about those cvars can be requested with mdd_help <cvar>.

Default values can be shown by typing the cvar into the console followed by pressing enter key. There are a few things worth noting:

• Some cvars end with _w, _xh or even _xywh. Here w stands for width, h for height and x and y for the coordinates. Multiple values are separated by spaces. E.g., mdd_ammo_graph_xywh 610 100 24 24, mdd_cgaz_yh 180 12.
• Some cvars have binary-literals as default values. They start with 0b followed by a sequence of 1's and 0's. E.g., mdd_ammo 0b0011, mdd_cgaz_trueness 0b110. Note that it's not necessary to have the same total number of 1's and 0's as there are different items for these cvars, or even use the binary representation altogether. You can still use the good old decimal equivalent (or the octal and hexadecimal representation to impress your friends).

Examples

mdd_ammo 0b1101

• draw the ammo hud
• show the ammo even if you don't have the weapon
• use gun icons instead of ammo icons
• use 3D models instead of 2D models

So if you want to use 2D models, simply use mdd_ammo 0b0101.

mdd_cgaz_trueness 0b110

• don't show true jump/crouch zones, ignore their influence
• show true CPM air control zones
• show true ground zones

Building

This C/C++ proxymod project uses CMake to control the building process. Both GitHub Actions and Visual Studio Code build tasks are available and basically do the following steps:

1. Generate input files for a native build system. To generate standard Makefiles for a 32-bit release build on Windows with gcc, do:

   $ cmake                                         \
       -S <repo_path>                              \
       -B <build_path>                             \
       -DBINARY_NAME=cgamex86                      \
       -DCMAKE_BUILD_TYPE=Release                  \
       -DCMAKE_C_COMPILER=gcc                      \
       -DCMAKE_CXX_COMPILER=g++                    \
       -DCMAKE_C_FLAGS="${CMAKE_C_FLAGS} -m32"     \
       -DCMAKE_CXX_FLAGS="${CMAKE_CXX_FLAGS} -m32"
   

   To generate Ninja files for a 64-bit debug build on Linux with clang, do:

   $ cmake                                         \
       -S <repo_path>                              \
       -B <build_path>                             \
       -G Ninja                                    \
       -DBINARY_NAME=cgamex86_64                   \
       -DCMAKE_BUILD_TYPE=Debug                    \
       -DCMAKE_C_COMPILER=clang                    \
       -DCMAKE_CXX_COMPILER=clang++                \
       -DCMAKE_C_FLAGS="${CMAKE_C_FLAGS} -m64"     \
       -DCMAKE_CXX_FLAGS="${CMAKE_CXX_FLAGS} -m64"
   

   Note that the binary name for a 32-bit Windows build is cgamex86, while cgamei386 on Linux. The binary name for a 64-bit build, however, is cgamex86_64 on both Windows and Linux.
2. Build the source code.

   $ cmake --build <build_path>
   

3. Optionally, you can strip and directly install the new binary into the defrag folder of your Quake III Arena directory by specifying an install prefix.

   $ cmake --install <build_path> --prefix <quake3_path>/defrag --strip
   

4. Profit.