Dethrace

Discord Chat Channel

Dethrace is an attempt to learn how the 1997 driving/mayhem game Carmageddon works behind the scenes and run it on modern systems.

Introduction

In 2014, Watcom debugging symbols for an earlier internal build were discovered on the Carmageddon Splat Pack expansion CD release. The symbols unfortunately did not match any known released executable, meaning they were interesting but not immediately usable to reverse engineer the game.

This is what it looked like from the Watcom debugger - the names of all the methods were present but the code location they were pointing to was junk:

CrayzKirk from the Carmageddon community then picked it up and did the painstaking work of manually matching up functions and data structures in the DOS executable to the debugging symbols.

After months of work, we are slowly replacing the original assembly code with equivalent C code.

Dependencies

SDL2

The easiest way to install SDL is via your favorite package manager.

OSX:

brew install SDL2

Linux:

apt-get install libsdl2-dev

Root content directory

Dethrace does not ship with any game content. You'll need access to the data from the original game. If you don't have an original CD then you can buy Carmageddon from GoG.com.

Point Dethrace at the Carmageddon install directory:

export DETHRACE_ROOT_DIR=/path/to/carmageddon

Build

Dethrace uses cmake for generating build files.

To generate the build files (generally only required once):

mkdir build
cd build
cmake ..

On cmake has generated the build files for your platform, run the build. For example:

make

Run

After building, build/dethrace is created

./dethrace [args]

Run tests

A subset of tests do not require DETHRACE_ROOT_DIR. They run via Github actions when code is committed to this repo. This allows us to keep nice and clean and avoid storing any potentially legally problematic resouces in our repo.

The majority of tests do require DETHRACE_ROOT_DIR.

To run the full test suite, you must have a copy of the original Splat Pack data.

export DETHRACE_ROOT_DIR=/path/to/carmageddon_splat_pack

To run

make test

To run a single test

DETHRACE_TEST_ARGS="-n test_name" make test

Changelog

From the beginning until release

Credits

• CrayzKirk (manually matching up functions and data structures in the executable to the debugging symbols)
• The developer at Stainless Software who left an old debugging .SYM file on the Splat Pack CD ;)

Legal

Dethrace is released to the Public Domain. The documentation and function provided by Dethrace may only be utilized with assets provided by ownership of Carmageddon.

The source code in this repository is for non-commerical use only. If you use the source code you may not charge others for access to it or any derivative work thereof.

Dethrace and any of its' maintainers are in no way associated with or endorsed by SCi, Stainless Software or THQ Nordic.