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

PERMISSION  UID  GID    PACKED    SIZE  RATIO METHOD CRC     STAMP     NAME
---------- ----------- ------- ------- ------ ---------- ------------ ----------
[unknown]               447870  976520  45.9% -lh5- ab1b May 19 19:18 chocolate-doom/chocolate-doom
[unknown]                23029   23029 100.0% -lh0- 5314 Dec 29 18:05 chocolate-doom/chocolate-doom.info
[unknown]               444566  970780  45.8% -lh5- 83e7 May 19 19:18 chocolate-doom/chocolate-heretic
[unknown]               497883 1140688  43.6% -lh5- ff39 May 19 19:18 chocolate-doom/chocolate-hexen
[unknown]                44340  100796  44.0% -lh5- a881 May 19 19:18 chocolate-doom/chocolate-server
[unknown]               103843  256792  40.4% -lh5- 12ab May 19 19:18 chocolate-doom/chocolate-setup
[unknown]               456093 1009016  45.2% -lh5- 1242 May 19 19:18 chocolate-doom/chocolate-strife
[unknown]                 3176   10348  30.7% -lh5- 1349 Dec 29 19:55 chocolate-doom/CMDLINE.txt
[unknown]                 7096   18431  38.5% -lh5- bfac Dec 29 19:55 chocolate-doom/COPYING.txt
[unknown]                 2141    5045  42.4% -lh5- 426f Dec 29 19:55 chocolate-doom/INSTALL.txt
[unknown]                22123   58802  37.6% -lh5- 48d5 Dec 29 19:55 chocolate-doom/NEWS.txt
[unknown]                 2731    6669  41.0% -lh5- 7ac0 Dec 29 19:55 chocolate-doom/NOT-BUGS.txt
[unknown]                 2857    6931  41.2% -lh5- 9727 Dec 29 19:55 chocolate-doom/README.Music.txt
[unknown]                 1713    3887  44.1% -lh5- 6602 Dec 29 19:55 chocolate-doom/README.txt
---------- ----------- ------- ------- ------ ---------- ------------ ----------
 Total        14 files 2059461 4587734  44.9%            May 22 18:38