diff options
Diffstat (limited to 'man/INSTALL.template')
| -rw-r--r-- | man/INSTALL.template | 150 |
1 files changed, 83 insertions, 67 deletions
diff --git a/man/INSTALL.template b/man/INSTALL.template index 6a26cc03..5597439f 100644 --- a/man/INSTALL.template +++ b/man/INSTALL.template @@ -1,16 +1,31 @@ +#ifdef DOOM +#define LONG_GAME_NAME Chocolate Doom +#define LONG_EXE_NAME chocolate-doom +#define DEFAULT_IWAD doom2.wad +#elif HERETIC +#define LONG_GAME_NAME Chocolate Heretic +#define LONG_EXE_NAME chocolate-heretic +#define DEFAULT_IWAD heretic.wad +#elif HEXEN +#define LONG_GAME_NAME Chocolate Hexen +#define LONG_EXE_NAME chocolate-hexen +#define DEFAULT_IWAD hexen.wad +#elif STRIFE +#define LONG_GAME_NAME Chocolate Strife +#define LONG_EXE_NAME chocolate-strife +#define DEFAULT_IWAD strife1.wad +#endif -Chocolate Doom installation -=========================== +== LONG_GAME_NAME installation == -These are instructions for how to install and set up Chocolate Doom +These are instructions for how to install and set up LONG_GAME_NAME for play. -#ifn PRECOMPILED -Building Chocolate Doom ------------------------ +#if !PRECOMPILED +== Building LONG_GAME_NAME == -Before you can play Chocolate Doom, you need to compile a binary that -you can run. For compilation, Chocolate Doom requires the following +Before you can play LONG_GAME_NAME, you need to compile a binary that +you can run. For compilation, LONG_GAME_NAME requires the following to be installed: * A C compiler (gcc is recommended) @@ -36,80 +51,82 @@ document. Please see the GNU autoconf / automake documentation for more information. #endif -Obtaining an IWAD file ----------------------- +== Obtaining an IWAD file == To play, you need an IWAD file. This file contains the game data (graphics, sounds, etc). The full versions of the games are proprietary and need to be bought. The IWAD file has one of the following names: +#if DOOM doom1.wad (Shareware Doom) doom.wad (Registered / Ultimate Doom) doom2.wad (Doom 2) tnt.wad (Final Doom: TNT: Evilution) plutonia.wad (Final Doom: Plutonia Experiment) chex.wad (Chex Quest) - heretic.wad (Heretic) +#endif +#if HERETIC + heretic1.wad (Shareware Heretic) + heretic.wad (Registered / Commercial Heretic) +#endif +#if HEXEN hexen.wad (Hexen) +#endif +#if STRIFE strife1.wad (+voices.wad) (Strife) +#endif +#if DOOM If you don't have a copy of a commercial version, you can download the shareware version of Doom (extract the file named doom1.wad): * http://www.doomworld.com/idgames/index.php?id=7053 (idstuff/doom/win95/doom95.zip in your nearest /idgames mirror) -If you have a commercial version, obtaining the IWAD file is usually -straightforward. The method depends on how you obtained your copy of -the game: - -#if _WIN32 - * The Doom games are available to buy for download on Steam - (http://www.steampowered.com/). Chocolate Doom will autodetect - IWADs installed by Steam and you do not need to do anything. -#else - * The Doom games are available to buy for download on Steam - (http://www.steampowered.com/), but are available for Windows only. - To find the IWAD files on a Windows system, look in the Steam - directory (usually within "Program Files"), under the - "steamapps/common" path. #endif +If you have a commercial version on a CD-ROM, obtaining the IWAD +file is usually straightforward. Simply locate the IWAD file on the +disc and copy it off. - * There have been several CD-based versions of Doom. Generally, the - IWAD files can be found on the CD and copied off directly. - +#if !STRIFE #if _WIN32 - * If you have a floppy disk version, you will need to run the install - program to install the game to your hard disk. As the installer is - DOS-based, you may not be able to do this on 64-bit versions of - Windows. In this case, the easiest suggestion is to use a DOS - emulator (such as DOSbox) to run the installer. +The Doom games, along with Heretic and Hexen, are also available to +purchase for download on Steam (http://www.steampowered.com/). +LONG_GAME_NAME will autodetect IWADs installed by Steam and you do +not need to do anything. #else - * If you have a floppy disk version, installation is more difficult. - The easiest suggestion is to use a DOS emulator (such as DOSbox) to - run the installer. +The Doom games, along with Heretic and Hexen, are available to buy +for download on Steam (http://www.steampowered.com/), but are only +available for Windows. To find the IWAD files on a Windows system, +look in the Steam directory (usually within "Program Files"), under +the "steamapps/common" path. #endif - * As an alternative to using an emulator, it is possible to extract - the files manually. On the install disk(s), you will find several - files with numbered extensions (eg. "doom_se.1"). +#endif +#if DOOM || HERETIC +Older floppy disk versions are harder to deal with. The easiest way +to install from floppies is to run the original installer program +inside an emulator such as DOSbox (http://www.dosbox.com/). +As an alternative to using an emulator, it is possible to extract the +files manually. On the install disk(s), you will find several files +with numbered extensions (eg. "doom_se.1"). - From the command line it is possible to combine these files into a - single large file, using a command similar to the following: +From the command line it is possible to combine these files into a +single large file, using a command similar to the following: #if _WIN32 - copy doom_se.1+doom_se.2+doom_se.3+doom_se.4+doom_se.5 doom_se.lha + copy doom_se.1+doom_se.2+doom_se.3+doom_se.4+doom_se.5 doom_se.lha #else - cat doom_se.1 doom_se.2 doom_se.3 doom_se.4 doom_se.5 > doom_se.lha + cat doom_se.1 doom_se.2 doom_se.3 doom_se.4 doom_se.5 > doom_se.lha #endif - The resulting file is an LHA archive file, and it can be extracted - using an LHA archive tool (there is one available for almost every - operating system). +The resulting file is an LHA archive file, and it can be extracted +using an LHA archive tool (there is one available for almost every +operating system). -Running the game ----------------- +#endif +== Running the game == #if __MACOSX__ Once you have an IWAD file, you can specify its location within the @@ -125,19 +142,19 @@ to point to the locations of the IWAD files set within the launcher. You can launch the game with a specific IWAD file by typing, for example: - chocolate-doom -iwad tnt.wad + LONG_EXE_NAME -iwad tnt.wad #else -Chocolate Doom needs to know where to find your IWAD file. To do this, +LONG_GAME_NAME needs to know where to find your IWAD file. To do this, do one of the following: #if _WIN32 * Within Explorer, simply place the IWAD file in the same folder as - the Chocolate Doom files, and double-click chocolate-doom.exe. + the LONG_GAME_NAME files, and double-click LONG_EXE_NAME.exe. - * Run Chocolate Doom from the command prompt with the '-iwad' command + * Run LONG_GAME_NAME from the command prompt with the '-iwad' command line parameter to specify the IWAD file to use, eg. - chocolate-doom -iwad c:\games\doom2.wad + LONG_EXE_NAME -iwad c:\games\DEFAULT_IWAD * Set the environment variable DOOMWADDIR to the location of a directory containing your IWAD files. @@ -147,10 +164,10 @@ do one of the following: of directories to search (similar to the PATH environment variable). #else - * Run Chocolate Doom from the Unix console with the '-iwad' command + * Run LONG_GAME_NAME from the Unix console with the '-iwad' command line parameter to specify the IWAD file to use, eg. - chocolate-doom -iwad /root/doom2.wad + LONG_EXE_NAME -iwad /root/DEFAULT_IWAD * Put the file into one of the following directories: @@ -167,12 +184,12 @@ do one of the following: #endif #endif -Playing with Chex Quest ------------------------ +#if DOOM +== Playing with Chex Quest == Chex Quest is a game based on Doom with some minor modifications that was distributed with boxes of Chex cereal in 1997. It is possible to -play Chex Quest using Chocolate Doom. To do this, the following files +play Chex Quest using LONG_GAME_NAME. To do this, the following files are needed: * The IWAD file 'chex.wad', from the Chex Quest CD. @@ -184,12 +201,11 @@ are needed: Copy these files into a directory together and use the '-iwad' command line parameter to specify the Chex Quest IWAD file: - chocolate-doom -iwad chex.wad + LONG_EXE_NAME -iwad chex.wad -Installing upgrades -------------------- +== Installing upgrades == -Chocolate Doom requires a version 1.9 IWAD file. Generally, if you +LONG_GAME_NAME requires a version 1.9 IWAD file. Generally, if you install a recent version of Doom you should have a version 1.9 IWAD. However, if you are installing from a very old CD version or from floppy disks, you might find you have an older version. @@ -215,10 +231,10 @@ As the patches are binary patches that run as DOS executables, you will need to use a DOS emulator (such as DOSBox) to run them. #endif -Music support -------------- +#endif +== Music support == -Chocolate Doom includes OPL emulation code that accurately reproduces +LONG_GAME_NAME includes OPL emulation code that accurately reproduces the way that the in-game music sounded under DOS when using an Adlib/Soundblaster card. This is, however, not to everyone's taste. @@ -245,7 +261,7 @@ be found here: http://www.doomworld.com/idgames/index.php?id=13928 (Doom idgames archive, /sounds/eawpats.zip) -Chocolate Doom also has provides a very limited form "emulation" of +LONG_GAME_NAME also has provides a very limited form "emulation" of the Gravis Ultrasound (GUS) card, using Timidity's GUS patch file support. To use this requires a copy of the GUS patch files, found here: @@ -253,7 +269,7 @@ here: http://www.doomworld.com/idgames/index.php?id=17127 (Doom idgames archive, /music/dgguspat.zip) -#ifn PRECOMPILED +#if !PRECOMPILED When compiling from source, be sure to compile and install Timidity before installing SDL_mixer. |