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