Chocolate Doom is a Doom source port that is conservative and historically accurate.
C Objective-C Makefile C++ M4 AppleScript
Latest commit 81f2c5b Aug 24, 2016 @chungy chungy p_spec: fix the wording of a comment about sector overflows
Thanks to @AXDOOMER for pointing this out. Closes #770
Failed to load latest commit information.
.github Add note to CONTRIBUTING guide about formatting. Jun 17, 2016
codeblocks Removed non-existing files from project Apr 17, 2016
data allow building in subdirectory or outside source directory Dec 26, 2014
man Update INSTALL.template Mar 24, 2016
msvc Allow SDL headers and libraries to exist in the msvc project directory Mar 6, 2016
opl opl: Nuked OPL3 v1.7.4 Jul 14, 2016
pcsound Clean up file headers. May 5, 2014
pkg Fix some references broken by markdown change. Jun 9, 2016
src p_spec: fix the wording of a comment about sector overflows Aug 24, 2016
textscreen Fix warning: variable ‘widget’ set but not used Nov 17, 2015
.gitignore Post-merge fixes: Created project for OPL library. Fixed OPL library to Sep 10, 2010
.lvimrc Add textscreen Doxyfile to dist. Add .desktop file to svn:ignore. Add Apr 30, 2010
.travis.yml Do make {install,dist} as part of travis build. Jun 9, 2016
AUTHORS Add Alexey to AUTHORS Mar 23, 2016
CODE_OF_CONDUCT.md Add Contributor Covenant as Code of Conduct. Feb 29, 2016
COPYING Update COPYING to latest version of GPL2 with new address of FSF (thanks Aug 20, 2011
ChangeLog Update URLs to Chocolate Doom Github project. Mar 16, 2014
HACKING.md Convert the rest of the doc files to Markdown. Jun 8, 2016
Makefile.am Convert the rest of the doc files to Markdown. Jun 8, 2016
NEWS.md Fix some references broken by markdown change. Jun 9, 2016
NOT-BUGS.md Convert the rest of the doc files to Markdown. Jun 8, 2016
PHILOSOPHY.md Convert the rest of the doc files to Markdown. Jun 8, 2016
README.Music.md Convert the rest of the doc files to Markdown. Jun 8, 2016
README.Strife.md Convert the rest of the doc files to Markdown. Jun 8, 2016
README.md README: Convert to Markdown format. Jun 7, 2016
TODO.md Convert the rest of the doc files to Markdown. Jun 8, 2016
acinclude.m4 Fix quoting around use of AC_LANG_PROGRAM macro to stop warning message. Nov 6, 2013
autogen.sh build: kill redundant boilerplate in autogen.sh Dec 10, 2013
configure.ac I don't think we need this anymore Jul 22, 2016
rpm.spec.in Fix some references broken by markdown change. Jun 9, 2016

README.md

Chocolate Doom

Chocolate Doom aims to accurately reproduce the original DOS version of Doom and other games based on the Doom engine in a form that can be run on modern computers.

Originally, Chocolate Doom was only a Doom source port. The project now includes ports of Heretic and Hexen, and Strife.

Chocolate Doom’s aims are:

  • To always be 100% Free and Open Source software.
  • Portability to as many different operating systems as possible.
  • Accurate reproduction of the original DOS versions of the games, including bugs.
  • Compatibility with the DOS demo, configuration and savegame files.
  • To provide an accurate retro “feel” (display and input should behave the same).

More information about the philosophy and design behind Chocolate Doom can be found in the PHILOSOPHY file distributed with the source code.

Setting up gameplay

For instructions on how to set up Chocolate Doom for play, see the INSTALL file.

Configuration File

Chocolate Doom is compatible with the DOS Doom configuration file (normally named default.cfg). Existing configuration files for DOS Doom should therefore simply work out of the box. However, Chocolate Doom also provides some extra settings. These are stored in a separate file named chocolate-doom.cfg.

The configuration can be edited using the chocolate-setup tool.

Command line options

Chocolate Doom supports a number of command line parameters, including some extras that were not originally suported by the DOS versions. For binary distributions, see the CMDLINE file included with your download; more information is also available on the Chocolate Doom website.

Playing TCs

With Vanilla Doom there is no way to include sprites in PWAD files. Chocolate Doom’s ‘-file’ command line option behaves exactly the same as Vanilla Doom, and trying to play TCs by adding the WAD files using ‘-file’ will not work.

Many Total Conversions (TCs) are distributed as a PWAD file which must be merged into the main IWAD. Typically a copy of DEUSF.EXE is included which performs this merge. Chocolate Doom includes a new option, ‘-merge’, which will simulate this merge. Essentially, the WAD directory is merged in memory, removing the need to modify the IWAD on disk.

To play TCs using Chocolate Doom, run like this:

chocolate-doom -merge thetc.wad

Here are some examples:

chocolate-doom -merge batman.wad -deh batman.deh vbatman.deh  (Batman Doom)
chocolate-doom -merge aoddoom1.wad -deh aoddoom1.deh  (Army of Darkness Doom)

Other information

  • Chocolate Doom includes a number of different options for music playback. See the README.Music file for more details.

  • More information, including information about how to play various classic TCs, is available on the Chocolate Doom website:

    https://www.chocolate-doom.org/

    You are encouraged to sign up and contribute any useful information you may have regarding the port!

  • Chocolate Doom is not perfect. Although it aims to accurately emulate reproduce the DOS executables, some behavior can be very difficult to reproduce. Because of the nature of the project, you may also encounter Vanilla Doom bugs; these are intentionally present; see the NOT-BUGS file for more information.

    New bug reports can be submitted to the issue tracker on Github:

    https://github.com/chocolate-doom/chocolate-doom/issues

  • Source code patches are welcome, but please follow the style guidelines - see the file named HACKING included with the source distribution.

  • Chocolate Doom is distributed under the GNU GPL. See the COPYING file for more information.

  • Please send any feedback, questions or suggestions to fraggle@gmail.com. Thanks!