README

   1
   2 Chocolate Doom is a Doom source port which aims to behave as closely
   3 as possible to the original DOS Doom executables.
   4
   5 Chocolate Doom aims to:
   6
   7  * Be compatible with DOS Doom demos
   8  * Be compatible with DOS Doom configuration files
   9  * Be compatible with DOS Doom savegames
  10  * Be compatible with DOS Doom bugs
  11  * Provide the same "feel" as DOS Doom (display and input should behave
  12    the same)
  13  * As far as possible, provide all the same features that are available
  14    using the DOS version.
  15
  16 == Configuration File ==
  17
  18 Chocolate Doom is compatible with the DOS Doom configuration file
  19 (normally named 'default.cfg').  Existing configuration files for
  20 DOS Doom should therefore simply work out of the box.  However,
  21 Chocolate Doom also provides some extra settings.  These are stored
  22 in a separate file named 'chocolate-doom.cfg'.
  23
  24 The configuration can be edited using the chocolate-setup tool.
  25
  26 == Command-line options ==
  27
  28 For a complete list of command-line options, see the CMDLINE
  29 file.
  30
  31 == Playing TCs ==
  32
  33 With Vanilla Doom there is no way to include sprites in PWAD files.
  34 Chocolate Doom's '-file' command line option behaves exactly the
  35 same as Vanilla Doom, and trying to play TCs by adding the WAD files
  36 using '-file' will not work.
  37
  38 Many Total Conversions (TCs) are distributed as a PWAD file which must
  39 be merged into the main IWAD.  Typically a copy of DEUSF.EXE is
  40 included which performs this merge.  Chocolate Doom includes a new
  41 option, '-merge', which will simulate this merge.  Essentially, the
  42 WAD directory is merged in memory, removing the need to modify the
  43 IWAD on disk.
  44
  45 To play TCs using Chocolate Doom, run like this:
  46
  47   chocolate-doom -merge thetc.wad
  48
  49 Here are some examples:
  50
  51   chocolate-doom -merge batman.wad -deh batman.deh vbatman.deh  (Batman Doom)
  52   chocolate-doom -merge aoddoom1.wad -deh aoddoom1.deh  (Army of Darkness Doom)
  53
  54 == Other information ==
  55
  56  * More information, including information about how to play various classic
  57    TCs, is available on the Chocolate Doom website:
  58
  59      http://www.chocolate-doom.org/
  60
  61    You are encouraged to sign up and contribute any useful information you may
  62    have regarding the port!
  63
  64  * Chocolate Doom is not perfect.  See the BUGS file for a list of known
  65    issues. New bug reports can be submitted to the Chocolate Doom bug
  66    tracker on Sourceforge.  See:
  67
  68      http://sourceforge.net/projects/chocolate-doom
  69
  70  * Source code patches are welcome, but please follow the style guidelines -
  71    see the file named HACKING included with the source distribution.
  72
  73  * Chocolate Doom is distributed under the GNU GPL.  See the COPYING file
  74    for more information.
  75
  76  * Please send any feedback, questions or suggestions to fraggle@gmail.com.
  77    Thanks!
  78