C CMake C++ Makefile Objective-C Python Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github ISSUE_TEMPLATE: Add intro comment with useful links. Jan 28, 2018
cmake Confirm that libpng and SRC works under MSYS2 Jun 9, 2018
data Install icons to PREFIX/share/icons/hicolor/128x128/apps Dec 9, 2017
man docgen: Fix links when capitalization doesn't match. May 28, 2018
midiproc Makefile.am: add CMakeLists.txt and win32 to EXTRA_DIST Jun 5, 2018
opl Makefile.am: add CMakeLists.txt and win32 to EXTRA_DIST Jun 5, 2018
pcsound Makefile.am: add CMakeLists.txt and win32 to EXTRA_DIST Jun 5, 2018
pkg win32: Include appropriate game-specific INSTALL files in Zips. Mar 17, 2018
src doom: Don't skip joy events when menu is closed Aug 12, 2018
textscreen Makefile.am: add CMakeLists.txt and win32 to EXTRA_DIST Jun 5, 2018
win32 Strife now boots May 10, 2018
.gitignore Ignore CMake build directories May 2, 2018
.lvimrc Add textscreen Doxyfile to dist. Add .desktop file to svn:ignore. Add Apr 30, 2010
.travis.sh travis: Treat warnings as errors Jan 27, 2018
.travis.yml Add cppcheck static analysis to travis build (#939) Sep 3, 2017
AUTHORS Add Alexey to AUTHORS Mar 23, 2016
CMakeLists.txt Address pull request comments Jun 4, 2018
CODE_OF_CONDUCT.md Add Contributor Covenant as Code of Conduct. Feb 29, 2016
COPYING.md Replace COPYING with COPYING.md Markdown version. Jan 15, 2018
ChangeLog Update URLs to Chocolate Doom Github project. Mar 16, 2014
HACKING.md doc: update the HACKING document with a rule for casts May 6, 2018
Makefile.am Remove the codeblocks project Jun 13, 2018
NEWS.md Remove the codeblocks project Jun 13, 2018
NOT-BUGS.md Convert the rest of the doc files to Markdown. Jun 8, 2016
PHILOSOPHY.md PHILOSOPHY: Minor formatting fixes Nov 27, 2016
README.Music.md README.Music: add gusgonna.wad reference May 27, 2018
README.Strife.md Convert the rest of the doc files to Markdown. Jun 8, 2016
README.md Fixed grammer error in README.md Aug 4, 2017
TODO.md Convert the rest of the doc files to Markdown. Jun 8, 2016
autogen.sh build: kill redundant boilerplate in autogen.sh Dec 10, 2013
configure.ac Update copyright year to 2018 May 30, 2018
rpm.spec.in Install icons to PREFIX/share/icons/hicolor/128x128/apps Dec 9, 2017

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 and 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 chocolate-doom-dev-list@chocolate-doom.org. Thanks!