INSTALL

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