DP Tool Club 19/CD_ASCQ_19_010295.iso/vrac/easyw110.zip/EASYWAD.DOC

Text File | 1994-09-15 | 19KB | 435 lines

DOOM EasyWAD v1.10 by M. van der Heide of ThunderWare Research Center
Release date: September 16, 1994

This program was made for all those DOOMers with loadsa WAD files. It
produces a nice WAD selection interface, which should put an end to losing
track of all these files. (At least I get more frustrated from finding that
particular WAD file and typing all that things on the command line than from
playing DOOM itself!).
An important feature is that it doesn't take any of your precious memory away.



DISCLAIMER:

  This program has been tested on several systems causing no problems
  whatsoever. If you want to use this program, though, you do so at your
  own risk. This means that it is extremely unlikely to damage your system,
  but if the unthoughtful event DOES happen, then you will be on your own.
  ThunderWare Research Center can and will accept no claims whatsoever.



HERE'S WHAT TO DO:

  You may unpack this program in any directory you like.
  You will first have to edit your configuration file: "EASYWAD.CFG".
  Separation between words is very simple: use a space, a tab or a newline.
  Empty lines are ignored; comment can be inserted by preceding it with a '#'
  character.
  The following keywords are available:

  - DOOMDIR      should be followed by the directory name of the DOOM program
                 files. The default is the current directory;
  - DOOMVERSION  is followed by your DOOM version number (currently 1.0, 1.1,
                 1.2, 1.4, 1.5, 1.6 and 1.666 are available)
                 This directly determines the available options. The default
                 version number is 1.0;
  - WADDIR       After this come all your directories that contain WAD files.
                 Any directory can be included, when needed preceded by a
                 drive:. The maximum number of directories is 400. A
                 directory "." means the current directory on that drive.
                 After any directory name may come an entry "-S" (or "/S"),
                 which means: handle all its subdirectories as well. If no
                 "WADDIR" is found, then the DOOM directory is used;
  - WADINFOFILE  is followed by a filename. The purpose of this filename is
                 explaned later in this document. If it is not found, then the
                 used filename will be "WADS.DSC" in the current directory;
  - SETSKILL     is used to change the default difficulty level. It is
                 followed by the skill level (1 = Pathetic, 5 = Megacool);
  - NOSEARCH     may be included to speed things up. The exact purpose is
                 explaned in the "THE WADINFOFILE" section;
  - DEATHMATCH   just selects deathmatch as default.
                 If you have DOOM v1.2, then this is the 'normal' deathmatch,
                 if you have DOOM v1.5, then this is deathmatch v2.0;
  - AUTOINCLUDE  is used to auto-select files that you always want to have
                 added. The maximum is 5 files. Any (partial) path should
                 also be found in the "WADDIR" series;
  - SETPLAYTYPE  must be followed by one of the fixed words
                 "ALONE", for one player;
                 "IPX", for IPX compatible multiplayer;
                 "NULL", for null-modem dualplayer;
  - SETCOMPORT   takes one parameter: the COM port number (1-4), which is used
                 when you choose to play with a null-modem link;
  - SETNODES     takes one parameter: the number of players (2-4), which is
                 used when you choose to play with an IPX compatible link;
  - ADDSWITCHES  After the keyword should all the other DOOM switches be
                 given, that are not handled from within EASYWAD. Currently
                 available switches are:
                 (1.2+) -NOJOY, -NOMOUSE, -NOMUSIC, -NOSFX, -NOSOUND;
                 Those switches are passed directly to DOOM;
  - SORTFILES    must be followed by one of the fixed words
                 "NAME", to sort all WAD files by name;
                 "INFO", to sort all WAD files by their info field.

  Note that you need the right DOOM version for the right switch. For example
  DEATHMATCH can not be choosen if you have DOOM v1.0 or v1.1, as this option
  was not yet implemented by that time.



LET'S GET STARTED:

  Start the wadmenu with the command "EW".
  You will seen a screen with the following items:

  - The episodes;
  - The skills;
  - The playtypes;
  - The starting level;
  - A DEATHMATCH item;
  - A DEATHMATCH v2.0 item;
  - A No monsters item;
  - A Respawn monsters item;
  - A Fast monsters item;
  - Loadsa WAD files with an info field!;
  - 2 pagers ("<<<" and ">>>");
  - A [ START DOOM! ] item;
  - A [ AUTO SELECT ] item;
  - A [READ PREVIOUS] item;
  - A mouse pointer if a mouse was found :)

  All items that are available only in higher DOOM versions than the one you
  specified in your configuration file are 'ghosted' (printed in dark grey).
  When you move the mouse, each line can be highlited. Use the left mouse
  button to select each field. You can select as many WAD files as you like.
  Just click again on a WAD file to de-select it. If you have more than 54
  WAD files, then use the pagers to see the next/previous page.
  You can quit directly by pressing the right mouse button or the [ESC] key.
  Notice that the files you typed in the configuration file after the keyword
  "AUTOINCLUDE" are already selected.

  [ START DOOM! ]  When you're done clicking, punch the left mouse button on
                   this field and play the selected DOOM part. What happened
                   is that the program made a batch file "START.BAT", which is
                   automatically started. This is useful (Yep, really!). If
                   you finished playing, but want to play the same thing again,
                   just type "START"  at the command line in stead of "EW".
  [READ PREVIOUS]  does the opposite. It reads the file "START.BAT" back and
                   sets all values accordingly. All files are automatically
                   selected.
  [ AUTO SELECT ]  automatically selects the correct episode and level to
                   start, according to the selected WAD files. This option
                   does not start the game, you still have to hit [START].

  Keyboard equivalents:

  'E'          Change (E)pisode;
  'L'          Change (L)evel;
  'S'          Change (S)kill;
  'T'          Change play(T)ype;
               if playtype is 'IPX compatible':
                 'N' Change (N)umber of players;
               if playtype is 'Null-modem link':
                 'C' Change (C)OM port number;
  'D'          Toggle (D)eathmatch;
  'V'          Toggle deathmatch (V)2.0. Notice that you cannot select both
               the deathmatch items;
  'M'          Toggle No (M)onsters item;
  'P'          Toggle Res(P)awn monsters item;
  'F'          Toggle (F)ast monsters item. Notice that 'No monsters' cannot
               be used in conjunction with respawn or fast monsters;
  'A'          Activate [AUTO] item;
  'R'          Activate [READ PREVIOUS] item;
  [ENTER]      Start game;
  [PAGE DOWN]  Next page of WAD files;
  [PAGE UP]    Previous page of WAD files;
  [ESC]        Abort EASYWAD.

  if no mouse was found, then select WAD files with the keys

  [CURS UP]    (Wraps to bottom)
  [CURS DOWN]  (Wraps to top)
  [CURS LEFT]  (Wraps to far right)
  [CURS RIGHT] (Wraps to far left)
  [SPACE]      (Un)select pointed WAD file

  You can also delete WAD files. This is done by pointing to one and then
  pressing [DEL]. A requester will pop up to confirm the deletion. Press
  'Y' to confirm, any other key to cancel.



THE INFOFIELD:

  After a WAD file name comes the infofield. The first part is the episodes
  and levels that are patched by this file; for example:
  E1M1 means: first episode (E1), first level (M1). The convention is:

  Ex-    means: the entire episode x, including the secret level;
  ExMy-z means: Episode x, levels y through z;
  ExMy,z means: Episode x, levels y and z;

  After this come the other patched parts:

  "c" = new (C)olors (palette change);
  "d" = new (D)emos;
  "s" = new (S)ound effects;
  "m" = new (M)usic;
  "p" = new s(P)rites;
  "g" = new (G)raphics.

  If a WAD file patches only one part, then the complete name is printed. For
  example, a file that only contains new music will have a field "music", etc.



THE WADINFOFILE:

  This file contains all the above information. Each file is seperated into
  four fields: drivenumber directory filename info
  The info field contains the exact info as on the screen. This field can be
  edited with any ASCII editor. If it exceeds 16 characters, then the rest is
  cut off. You could add a mark for how much you like this WAD, or a sign that
  says 'especially cool on DEATHMATCH', or anything else; just no longer than
  16 characters.
  The file is created when it did not exist at startup, or when you run
  "EW -R" (or "EASYWAD -R", after which you should run "START" yourself :)
  Unfortunately this does also overwrite your own additional info.

  The option "NOSEARCH" should be used with some caution. Usually, EASYWAD
  will search all given WADDIR directories for WAD files (and write a
  WADINFOFILE if needed). "NOSEARCH" forces the program to NOT search the
  directories, but to use the WADINFOFILE directly to obtain all WAD file
  statistics. This REALLY speeds up things when using LOADS of WAD files or
  WAD files on cd-rom. The problem comes if you add or delete a WAD file (or
  even a WAD directory). As no directories are scanned, the program will be
  unable to notice the changes, and still display the 'old' list. So, if you
  use this option and change ANYTHING in your filesystem, including deletion
  from within EASYWAD, be sure to use "EW -R" (or "EASYWAD -R") to update
  the WADINFOFILE!



USING A DIFFERENT CONFIGURATION FILE:

  The default configuration file is "EASYWAD.CFG". You can use a different
  file by adding the command line parameter +<new_config_file>. This option
  is particularly useful if you have WAD files on a CD-ROM. You could make a
  configuration file, say "CDWADS.CFG", which contains the following lines
  (assuming that your CD-ROM drive is called E:)

  DOOMVERSION <your_DOOM_version>
  DOOMDIR <your_main_DOOM_directory>
  WADDIR E:\ /S                        # All subdirs from the root
  WADINFOFILE CDWADS.DSC               # Should be different than the normal
  NOSEARCH                             # The CD-ROM never changes contents
  SORTFILES INFO                       # Sort all files by their info field

  If you want to access these file, than start with "EW +CDROM.CFG"



NOTE TO THOSE WHO ARE UPGRADING FROM VERSION 1.02:

  People who are upgrading from version or 1.02 are requested to start
  EASYWAD the first time with "EW -R" (or "EASYWAD -R"), as the WADINFOFILE
  has undergone several major changes.



LIMITS:

  The program can handle a maximum of 1000 WAD files. 54 files are printed in
  a page on the selection screen. Just click on a 'pager' and the next page is
  displayed. The maximum number of directories is 400.



CONSIDERATIONS:

  Remember that all the things you selected are put on one command line
  (in "START.BAT") One line should not exceed 128 characters, for COMMAND.COM
  (your command prompter) to be able to read it completely. (This problem has
  been solved in version 1.5 of DOOM).
  The message: keep your path(name)s as short as possible! A good trick is:
  If you have wadfiles on a different drive, then first change the current
  directory of that drive to the WADs directory and use an entry "drive:." as a
  "WADDIR" entry.
  For example: the DOOM drive is C: and you also have extra WAD files on D: in
  the directory "\DOOM\WADS".
  Then you should edit "EW.BAT" to start with the command "CD D:\DOOM\WADS"
  and edit "EASYWAD.CFG" to hold "WADDIR D:."

  Notice that you do not have to 'Press return to continue' when you start
  DOOM with a selected WAD file.


Good luck!

If you use this program, please drop a note (you like it, you hate it, you
would like things changed) at the following email address:

martijn@.htsa.hva.nl



COPYRIGHTS:

  This program has NO copyrights whatsoever.
  If it causes any problems ... yeah, right!
  This absolutely freeware program may be edited and distributed at taste.
  The only thing that I ask is to distribute the complete package.



CREDITS GO TO:

  - The makers of DOOM (Id Software). They changed my life completely.
  - The makers of DMSPEC12.TXT (Matt Fell & Hank Leukart). This is where I
    found the info on the structure of a WAD file;
  - The makers of DEU (Doom Editor Utility, by Brendon Wyber & Raphael Quinet)
    for their commented source. I use a few of their namings in my source.
    (defines THING_..., fieldnames in structures).



ADDITIONAL CREDITS GO TO:

  - J.J. Kwast of ThunderWare Research Center. He gave me the constructive
    criticism I needed when he wasn't DEU-ing.
  - B. Castricum for 'play-testing' and giving additional comments.
  - Everyone else who gave reactions.
  - All those people out there that are constantly creating new WAD files.



CHANGES AFTER VERSION 1.06 (release September 12, 1994)

  - Rearranged screen layout to be able to build the following:
  - Added 'No monsters', 'Respawn monsters' and 'fast monsters' items;
  - Added 'DEATHMATCH! v2.0' item;
  - Added key equivalents for the above;
  - Changed videoroutines; Now unavailable options are 'ghosted' in stead of
    'not printed'. This looks better;
  - Changed old routines for speed;
  - Erased 'ADDSWITCHES' items '-NOMONSTERS', '-RESPAWN' and '-ALTDEATH', as
    these are now handled from within EASYWAD;
  - Fixed some version errors.
  - Added [DEL] key to delete WAD files.



CHANGES AFTER VERSION 1.05 (release September 9, 1994):

  - Changed switch "-WART" in "-WARP", as WART is no longer valid in version
    1.666 of DOOM. Sorry for the delay;
  - Hi-lighting problem remained in file selection part. Fixed;
  - Found some (minor) version errors. Fixed;
  - Added some more comment in the source file.



CHANGES AFTER VERSION 1.03 (release September 5, 1994):

  - Added "ADDSWITCHES" to allow direct passing of un-covered DOOM switches;
  - Added "SORTFILES" to allow for file sorting before displaying;
  - Added several DOOM version checks;
  - Changed all display and field-handling routines. Fields are no longer
    printed if the DOOM version is too low;
  - Added WAD-file directory identifiers "INFOPACK" and "PLATFORM", which I
    found in a lot of WADfiles. They were previously treated as New Graphics
    (Those identifiers are NOT from Id SoftWare!)
  - Shorted some code, as I got the funny message 'Out of near heap space'
    while compiling ...



CHANGES AFTER VERSION 1.02 (release August 25, 1994):

  - Changed program location: EASYWAD is no longer forced to be in your DOOM
    directory;
  - Added "DOOMDIR" in configfile to allow for this change;
  - Added new scanning routine for the configfile to allow comment lines;
  - Added keyboard equivalents for all selection types. This also means that
    a mouse is longer needed;
  - Removed the bug from EW.BAT that created 'Syntax error';
  - Added support for higher versions of DOOM. The most important change is
    that you can now select more WAD files, as since version 1.5 of DOOM you
    are allowed to make a file from the command line options;
  - Added "DOOMVERSION" in configfile to allow for this change;
  - Erased "Modem setup" from playtype field on screen, as this would take
    far too much administration. sorry :)
  - Added "SETPLAYTYPE" in configfile to change the default playtype;
  - Added "SETNODES" in configfile to set the default number of players in a
    multiplayer IPX game;
  - Added "SETCOMPORT" in configfile to set the default COM port when using
    the null-modem link game;
  - Added "Number of players"/"COM port" on screen;
  - When you moved the mouse too quikly, some hi-lighted items kept being
    hi-lighted. Fixed;
  - Completely changed layout of this DOC file.



CHANGES AFTER VERSION 1.01 (release August 4, 1994):

  - Added [AUTO] field;
  - Added ability to scan for possible shorter paths to WAD files;
  - Added "AUTOINCLUDE" in configfile;
  - Added "NOSEARCH" in configfile;
  - Added routines, defines and structures to be able to read info on a WAD
    file directly from the file itself;
  - Changed maximum of WADfiles on screen from 100 to 60 to allow for a longer
    info fields (from 10 to 16 chars);
  - Added item "-S" in "WADDIR" field to allow for handling subdirectories;
  - Added switch "-R" on the command line to Rescan all "WADDIR" items;
  - Added switch "+file" on the command line to allow for different config
    files;
  - Changed "EW.BAT" for the new switches;
  - Added keyboard check for 'escape': abort;
  - Partial rewrite of the code, to gain some speed;
  - Added some checks to prevent the code from hanging the system :)



CHANGES AFTER VERSION 1.00 (internal release July 17, 1994):

  - A few bugfixes :)
  - Added [READ PREVIOUS] field;
  - Added [START] field;
    - Start game is now done by clicking [START] i.s.o. the right mouse button;
    - Changed meaning of right mouse button to: abort;
  - Added "SETSKILL" in configfile;
  - Added "DEATHMATCH" in configfile;
  - Changed location of 'program name' on screen to the top;



CONTENTS OF THE EASYWAD PACKAGE

This package should contain the following files:

  EASYWAD.DOC - Guess what? You're reading it!
  EASYWAD.EXE - The main thing
  EASYWAD.CFG - An example configuration file
  EW.BAT      - The usual entrance :)
  EASYWAD.C   - The source code of this utility

If any part is missing, please contact me at the above address to receive the
full copy.



WHAT YOU NEED:

  The same stuff as for DOOM:

  - A PC (minumum is a '386 for DOOM and a '286 for this proggie);
  - A VGA screen;

  Extra:

  - An initialized mouse (recommended);
  - A few spare sectors on your harddisk.