ref: 3542f5b20dd7342b642f8434ec3c5799df21e8bb
dir: /README.md/
# Chocolate Duke3D Chocolate Duke Nukem 3D is the equivalent of [Chocolate Doom](http://www.chocolate-doom.org/wiki/index.php/Chocolate_Doom). A **port** that: 1. Remains as faithful as possible to the original source code. 2. Portable and compiling in one click on Windows, OS X and Linux. 3. Aimed at education, with lots of comments and documentation added in order to help programmers to understand and learn. ## Belgian Chocolate Duke3D This is a fork of Fabien Sanglard's project [Chocolate Duke Nukem 3D](https://github.com/fabiensanglard/chocolate_duke3D). As of January 2020, Fabien has archived his git repository. After reading both Fabien Sanglard's Game Engine Black Books on [Wolfenstein 3D](https://github.com/fabiensanglard/gebbwolf3) and [Doom](https://github.com/fabiensanglard/gebbdoom), I slowly got curious on how Duke 3D would perform on a modern computer (an Intel Core i9-9900K) with a modern Operating System (Windows 10 and Ubuntu 18.04). After cloning his Chocolate Duke 3D git repository, I had to spend a bit of time getting the project up and running. While doing that, I've been keeping on adding some improvements. * Ported to SDL2. * Ported to vcpkg and CMake. * Added continuous integration (via GitHub Actions). * Added 64-bit support. ### Known Issues * Save games are not compatible between 32-bit and 64-bit (due to serialization of `intptr_t` values). * Linux: MIDI does not play (vcpkg does not configure sdl2-mixer for it). * Engine: Leaning left/right falls back to low-res rendering. * Engine: Minimap has rendering glitches when fully-textured. * Engine: Pixel imprecision when rendering health/ammo numbers in the status bar, leaving ghost pixels. ## Requirements An original copy of [Duke Nukem 3D](https://3drealms.com/catalog/duke-nukem-3d_27/). Specifically the DUKE3D.GRP file from the original CD in binary working directory. ## Build **Windows (Visual Studio 2019 x64 solution)** [](https://github.com/GPSnoopy/BelgianChocolateDuke3D/actions?query=workflow%3A%22Windows+CI%22) ``` > vcpkg_windows.bat > build_windows.bat ``` **Linux (GCC Makefile)** [](https://github.com/GPSnoopy/BelgianChocolateDuke3D/actions?query=workflow%3A%22Linux+CI%22) ```bash > sudo apt-get install libsdl2-mixer-dev > ./vcpkg_linux.sh > ./build_linux.sh ``` **MacOS** _Not yet supported._ ## Contributors * **Project Initiator:** [Fabien Sanglard](https://github.com/fabiensanglard) * **Linux Integration:** [Juan Manuel Borges Caño](https://github.com/juanmabc) * **64-bit Port:** [Rohit Nirmal](https://github.com/rohit-n) * **64-bit Port:** [Jonathon Fowler] (https://github.com/jonof/jfduke3d) * **Belgian Chocolate fork:** [Tanguy Fautre](https://github.com/GPSnoopy/) ## More Information * **[Review of the Duke 3D source code](http://fabiensanglard.net/duke3d/)** * [Simple DirectMedia Layer](https://wiki.libsdl.org/FrontPage), [SDL_Mixer](http://www.libsdl.org/projects/SDL_mixer/) * [Duke Nukem 3D](https://3drealms.com/catalog/duke-nukem-3d_27/)