INSTALL

   1
   2 Chocolate Doom installation
   3 ===========================
   4
   5 These are instructions for how to install and set up Chocolate Doom
   6 for play.
   7
   8 Building Chocolate Doom
   9 -----------------------
  10
  11 Before you can play Chocolate Doom, you need to compile a binary that
  12 you can run.  If you are using Windows or Mac OS X, precompiled
  13 binaries are available on the website for download, and you can skip
  14 this section.
  15
  16 For compilation, Chocolate Doom requires the following to be installed:
  17
  18  * A C compiler (gcc is recommended)
  19  * make (GNU make is recommended)
  20  * LibSDL (see http://www.libsdl.org/)
  21  * SDL_mixer (see http://www.libsdl.org/projects/SDL_mixer/)
  22  * SDL_net (see http://www.libsdl.org/projects/SDL_net/)
  23  * Python (optional)
  24
  25 Follow the standard instructions for installing an autotools-based
  26 package:
  27
  28  1. Run './configure' to initialize the package.
  29  2. Run 'make' to compile the package.
  30  3. Run 'make install' to install the package.
  31
  32 Advanced topics such as cross-compilation are beyond the scope of this
  33 document.  Please see the GNU autoconf / automake documentation for more
  34 information.
  35
  36 Obtaining an IWAD file
  37 ----------------------
  38
  39 To play Doom, you need an IWAD file.  This file contains the game data
  40 that is used in gameplay (graphics, sounds, etc).  The full versions of
  41 the Doom games are proprietary and need to be bought.  The IWAD file
  42 has one of the following names:
  43
  44    doom1.wad                   (Shareware Doom)
  45    doom.wad                    (Registered / Ultimate Doom)
  46    doom2.wad                   (Doom 2)
  47    tnt.wad                     (Final Doom: TNT: Evilution)
  48    plutonia.wad                (Final Doom: Plutonia Experiment)
  49    chex.wad                    (Chex Quest)
  50
  51 If you don't have a copy of the commercial version, you can download
  52 the shareware version (extract the file named doom1.wad):
  53
  54  * http://www.doomworld.com/idgames/index.php?id=7053
  55    (idstuff/doom/win95/doom95.zip in your nearest /idgames mirror)
  56
  57 If you have a commercial version, obtaining the IWAD file may slightly
  58 complicated.  The method depends on how you obtained your copy of the
  59 game:
  60
  61  * There have been several CD-based versions of Doom.  Generally, the
  62    IWAD files can be found on the CD and copied off directly.
  63
  64  * The IWAD files might not be directly available on the CD.  Look for
  65    a program named "deice.exe".  In the same directory, there should
  66    be a single large file with a numbered extension (eg.
  67    "resource.1"); to extract this, follow the same instructions as for
  68    the floppy disk version (see below).
  69
  70  * If you have the floppy disk version of Doom, first copy the
  71    contents of all the floppy disks into a directory together.  You
  72    will have several large files with numbered extensions.
  73    Concatenate these into a single file, eg.
  74
  75      (Unix instructions)
  76      cat doom_se.1 doom_se.2 doom_se.3 doom_se.4 doom_se.5 > doom_se.exe
  77
  78      (Windows/DOS instructions)
  79      copy doom_se.1+doom_se.2+doom_se.3+doom_se.4+doom_se+5 doom_se.exe
  80
  81    The resulting file is self-extracting LHA file.  If you have a DOS
  82    emulator (such as DOSbox), you can run it to extract the files;
  83    alternatively, you can use the Unix LHA tool to extract the
  84    archive.
  85
  86  * The Doom games are also available for download on Steam
  87    (http://www.steampowered.com/).  To find the IWAD files, look in
  88    your Steam directory, under the "steamapps/common" path.
  89
  90 Running the game
  91 ----------------
  92
  93 When you have an IWAD file, install it through one of the following
  94 methods:
  95
  96  * Under Mac OS X, you can specify the locations of the IWAD files
  97    through the graphical launcher program.  Click the "Configure..."
  98    button, and then click "Set..." for each IWAD location to choose
  99    its location.
 100
 101  * Under Unix, put the file into the /usr/share/games/doom or
 102    /usr/local/share/games/doom directories.
 103
 104  * Place it in a directory and set the environment variable DOOMWADDIR
 105    to be the path to that directory.
 106
 107  * Install multiple IWADs into separate directories and set the
 108    environment variable DOOMWADPATH to be a colon-separated list of
 109    directories to search (similar to the Unix PATH environment
 110    variable).
 111
 112  * Run Chocolate Doom with the '-iwad' command line parameter to
 113    specify the IWAD file to use, eg.
 114
 115        chocolate-doom -iwad /root/doom2.wad
 116
 117 Playing with Chex Quest
 118 -----------------------
 119
 120 Chex Quest is a game based on Doom with some minor modifications that
 121 was distributed with boxes of Chex cereal in 1997.  It is possible to
 122 play Chex Quest using Chocolate Doom.  To do this, the following files
 123 are needed:
 124
 125  * The IWAD file 'chex.wad', from the Chex Quest CD.
 126
 127  * The dehacked patch 'chex.deh', which can be found in the /idgames
 128    repository in utils/exe_edit/patches/chexdeh.zip.
 129
 130 Copy these files into a directory together and use the '-iwad' command
 131 line parameter to specify the Chex Quest IWAD file:
 132
 133    chocolate-doom -iwad chex.wad
 134
 135 Installing upgrades
 136 -------------------
 137
 138 Chocolate Doom requires a Doom 1.9 IWAD file.  Generally, if you
 139 install a recent version of Doom you should automatically have a 1.9
 140 IWAD.  However, if you are installing from a very old CD version or
 141 from floppy disks, you might find you have an older version.
 142
 143 The most obvious symptom of an out of date IWAD file is that the game
 144 will exit at the title screen before the demo starts, with the message
 145 "Demo is from a different game version!".  If this happens, your IWAD
 146 file is out of date and you need to upgrade.
 147
 148 Id Software released upgrade patches that will update your game to
 149 1.9.  The following sites have the patches:
 150
 151   http://www.doomworld.com/files/patches.shtml
 152   http://www.doom2.net/doom2/utils.html
 153   ftp://ftp.idsoftware.com/idstuff/doom2
 154
 155 As the patches are binary patches that run as DOS executables, you
 156 will need a DOS emulator (such as DOSBox) to install them.
 157
 158 Music support
 159 -------------
 160
 161 Support for Doom's MIDI music is available through Timidity:
 162
 163   http://timidity.sourceforge.net/
 164
 165 A good set of patches for Timidity is the eawpats collection, which can
 166 be found here:
 167
 168   http://www.doomworld.com/idgames/index.php?id=13928
 169   (Doom idgames archive, /sounds/eawpats.zip)
 170
 171 If compiling from source, be sure to compile and install timidity
 172 before installing SDL_mixer.
 173