home *** CD-ROM | disk | FTP | other *** search
/ Tricks of the DOOM Programming Gurus / Tricks_of_the_Doom_Programming_Gurus.iso / bonus / utils / easywad2 / easywad2.doc < prev    next >
Encoding:
Text File  |  1995-02-18  |  14.8 KB  |  351 lines
  1. DOOM ][ EasyWAD2 v1.01 by M. van der Heide of ThunderWare Research Center
  2. Release date: Februari 18, 1995
  3.  
  4. This program was made for all those DOOMers with loadsa WAD files. It 
  5. produces a nice WAD selection interface, which should put an end to losing
  6. track of all these files. (At least I get more frustrated from finding that
  7. particular WAD file and typing all that things on the command line than from
  8. playing DOOM ][ itself!).
  9. An important feature is that it doesn't take any of your precious memory away.
  10.  
  11.  
  12. NEW IN THIS VERSION:
  13.  
  14.   No new items have been added actually, but I managed to optimize it all,
  15.   using a newer compiler/linker version. Things go A LOT smoother now.
  16.   I also removed the last few (non-annoying) bugs (thanks go to all people
  17.   mentioning them).
  18.  
  19.  
  20. DISCLAIMER:
  21.  
  22.   This program has been tested on several systems causing no problems
  23.   whatsoever. If you want to use this program, though, you do so at your
  24.   own risk. This means that it is extremely unlikely to damage your system,
  25.   but if the unthoughtful event DOES happen, then you will be on your own.
  26.   ThunderWare Research Center can and will accept no claims whatsoever.
  27.  
  28.  
  29.  
  30. HERE'S WHAT TO DO:
  31.  
  32.   You may unpack this program in any directory you like.
  33.   You will first have to edit your configuration file: "EASYWAD2.CFG".
  34.   Separation between words is very simple: use a space, a tab or a newline.
  35.   Empty lines are ignored; comment can be inserted by preceding it with a '#'
  36.   character.
  37.   The following keywords are available:
  38.  
  39.   - DOOMDIR      should be followed by the directory name of the DOOM program
  40.                  files. The default is the current directory;
  41.   - WADDIR       After this come all your directories that contain WAD files.
  42.                  Any directory can be included, when needed preceded by a
  43.                  drive:. The maximum number of directories is 400. A
  44.                  directory "." means the current directory on that drive.
  45.                  After any directory name may come an entry "-S" (or "/S"),
  46.                  which means: handle all its subdirectories as well. If no
  47.                  "WADDIR" is found, then the DOOM directory is used;
  48.   - WADINFOFILE  is followed by a filename. The purpose of this filename is
  49.                  explaned later in this document. If it is not found, then the
  50.                  used filename will be "WADS.DSC" in the current directory;
  51.   - SETSKILL     is used to change the default difficulty level. It is 
  52.                  followed by the skill level (1 = Pathetic, 5 = Megacool);
  53.   - NOSEARCH     may be included to speed things up. The exact purpose is
  54.                  explaned in the "THE WADINFOFILE" section;
  55.   - DEATHMATCH   just selects deathmatch V2 as default.
  56.   - AUTOINCLUDE  is used to auto-select files that you always want to have 
  57.                  added. The maximum is 5 files. Any (partial) path should
  58.                  also be found in the "WADDIR" series;
  59.   - SETPLAYTYPE  must be followed by one of the fixed words
  60.                  "ALONE", for one player;
  61.                  "IPX", for IPX compatible multiplayer;
  62.                  "SERIAL", for (null)modem dualplayer;
  63.   - SERDRIVER    is followed by the filename of the program you will use in
  64.                  stead on "SERSETUP".
  65.                  If this new driver uses parameters, then quote it all with
  66.                  '"' characters. (e.g. SERDRIVER "RMSSETUP -NODES 3");
  67.   - SETCOMPORT   takes one parameter: the COM port number (1-4), which is used
  68.                  when you choose to play with a null-modem link;
  69.                  This is only used if you have not defined an alternate
  70.                  SERDRIVER;
  71.   - IPXDRIVER    is followed by the filename of the program you will use in
  72.                  stead of "IPXSETUP".
  73.                  If this new driver uses parameters, then quote it all with
  74.                  '"' characters.
  75.   - SETNODES     takes one parameter: the number of players (2-4), which is
  76.                  used when you choose to play with an IPX compatible link;
  77.   - SETSOCKET    With this option, you can select the network socket you want
  78.                  to use when playing network DOOM. (0-255). The default is 0.
  79.                  SETNODES and SETSOCKET are only used if you have not
  80.                  defined an alternate IPXDRIVER;
  81.   - ADDSWITCHES  After the keyword should all the other DOOM switches be
  82.                  given, that are not handled from within EASYWAD2. Currently
  83.                  available switches are:
  84.                  -NOJOY, -NOMOUSE, -NOMUSIC, -NOSFX, -NOSOUND;
  85.                  Those switches are passed directly to DOOM;
  86.   - SORTFILES    must be followed by one of the fixed words
  87.                  "NAME", to sort all WAD files by name;
  88.                  "INFO", to sort all WAD files by their info field.
  89.   - NOFULLNAME   (no parameters). Usually, the INFOFIELD will be filled with
  90.                  the full name of a patch other than levels, if that patch is
  91.                  the only one (for example, if only music is patched, then
  92.                  the INFOFIELD will read "music"). Use this switch to over-
  93.                  ride this.
  94.   - NOAUTORETURN (no parameters). Use this switch if you declared a different
  95.                  SERDRIVER or IPXDRIVER and this new driver requires you to
  96.                  press some keys before starting.
  97.  
  98.   Simple modem support is now available through the configuration file.
  99.   You should use the following combinations:
  100.  
  101.   SETPLAYTYPE SERIAL
  102.   SERDRIVER "SERSETUP -COM<port> -DIAL <phonenumber> -<baudrate>"
  103.  
  104.   Anything (as found in the README.COM file) related to the modem can be
  105.   included in between the quotes (-ANSWER, -IRQ, -PORT, -DIAL etc.)
  106.   Just USE THE QUOTES, as an error-message will be given if you don't!
  107.  
  108.  
  109.  
  110. LET'S GET STARTED:
  111.  
  112.   Start the wadmenu with the command "EW".
  113.  
  114.   DO NOT START WITH "EASYWAD2", AS THIS WILL DROP YOU BACK TO DOS AFTER YOU
  115.   HAVE SELECTED EVERYTHING!
  116.  
  117.   You will see a screen with the following items:
  118.  
  119.   - The skills;
  120.   - The playtypes;
  121.   - The starting map;
  122.   - 2 map pagers ("<<<" and ">>>");
  123.   - A DEATHMATCH item;
  124.   - A DEATHMATCH v2.0 item;
  125.   - A No monsters item;
  126.   - A Respawn monsters item;
  127.   - A Fast monsters item;
  128.   - Loadsa WAD files with an info field!;
  129.   - 2 WAD pagers ("<<<" and ">>>");
  130.   - A ( START DOOM2 ) item;
  131.   - A ( AUTO SELECT ) item;
  132.   - A (READ PREVIOUS) item;
  133.   - A mouse pointer if a mouse was found :)
  134.  
  135.   When you move the mouse, each line can be highlited. Use the left mouse
  136.   button to select each field. You can select as many WAD files as you like.
  137.   Just click again on a WAD file to de-select it. If you have more than 54
  138.   WAD files, then use the pagers to see the next/previous page.
  139.   You can quit directly by pressing the right mouse button or the [ESC] key.
  140.   Notice that the files you typed in the configuration file after the keyword
  141.   "AUTOINCLUDE" are already selected.
  142.  
  143.   ( START DOOM2 )  When you're done clicking, punch the left mouse button on
  144.                    this field and play the selected DOOM part. What happened
  145.                    is that the program made a batch file "START.BAT", which is
  146.                    automatically started. This is useful (Yep, really!). If
  147.                    you finished playing, but want to play the same thing again,
  148.                    just type "START"  at the command line in stead of "EW".
  149.   (READ PREVIOUS)  does the opposite. It reads the file "START.BAT" back and
  150.                    sets all values accordingly. All files are automatically
  151.                    selected.
  152.   ( AUTO SELECT )  automatically selects the correct episode and level to
  153.                    start, according to the selected WAD files. This option
  154.                    does not start the game, you still have to hit [START].
  155.  
  156.   Keyboard equivalents:
  157.  
  158.   '.'          Select next map (This is the key with '>' on it!)
  159.   ','          Select previous map (This is the key with '<' on it!)
  160.   'S'          Change (S)kill;
  161.   'T'          Change play(T)ype;
  162.                if playtype is 'IPX compatible' and you have no alternative
  163.                IPXDRIVER:
  164.                  'N' Change (N)umber of players;
  165.                if playtype is 'Null-modem link' and you have no alternative
  166.                SERDRIVER:
  167.                  'C' Change (C)OM port number;
  168.   'D'          Toggle (D)eathmatch;
  169.   'V'          Toggle deathmatch (V)2.0. Notice that you cannot select both
  170.                the deathmatch items;
  171.   'M'          Toggle No (M)onsters item;
  172.   'P'          Toggle Res(P)awn monsters item;
  173.   'F'          Toggle (F)ast monsters item. Notice that 'No monsters' cannot
  174.                be used in conjunction with respawn or fast monsters;
  175.   'A'          Activate [AUTO] item;
  176.   'R'          Activate [READ PREVIOUS] item;
  177.   [ENTER]      Start game;
  178.   [PAGE UP]    Next page of WAD files;
  179.   [PAGE DOWN]  Previous page of WAD files;
  180.   [ESC]        Abort EasyWAD.
  181.  
  182.   Other keys, which have no mouse equivalents, are:
  183.  
  184.   [DEL]        Delete the pointed WAD file;
  185.   [F1]         Show available keys;
  186.   [F5]         Rescan the given WADDIR directories (the same as EASYWAD2 -R);
  187.   [F7]         Toggle NOFULLNAME (as found in the configuration file);
  188.   [F8]         Resort all WAD files in memory. You will toggle between sort
  189.                by filename and sort by infofield.
  190.  
  191.   if no mouse was found, then select WAD files with the keys
  192.  
  193.   [CURS UP]    (Wraps to bottom)
  194.   [CURS DOWN]  (Wraps to top)
  195.   [CURS LEFT]  (Wraps to far right)
  196.   [CURS RIGHT] (Wraps to far left)
  197.   [SPACE]      (Un)select pointed WAD file
  198.  
  199.  
  200.  
  201. THE INFOFIELD:
  202.  
  203.   After a WAD file name comes the infofield. The first part shows the maps
  204.   that are patched by this file;
  205.  
  206.   Mx-y means: Maps x through y;
  207.   Mx,y means: Maps x and y;
  208.  
  209.   After this come the other patched parts:
  210.  
  211.   "c" = new (C)olors (palette change);
  212.   "d" = new (D)emos;
  213.   "s" = new (S)ound effects;
  214.   "m" = new (M)usic;
  215.   "p" = new s(P)rites;
  216.   "g" = new (G)raphics.
  217.  
  218.   If a WAD file patches only one part, then the complete name is printed. For
  219.   example, a file that only contains new music will have a field "music", etc.
  220.   unless "NOFULLNAME" was given in the configuration file.
  221.  
  222.  
  223.  
  224. THE WADINFOFILE:
  225.  
  226.   This file contains all the above information. Each file is seperated into
  227.   four fields: drivenumber directory filename info
  228.   The info field contains the exact info as on the screen. This field can be
  229.   edited with any ASCII editor. If it exceeds 16 characters, then the rest is
  230.   cut off. You could add a mark for how much you like this WAD, or a sign that
  231.   says 'especially cool on DEATHMATCH', or anything else; just no longer than
  232.   16 characters.
  233.   The file is created when it did not exist at startup, or when you run
  234.   "EW -R" (or "EASYWAD2 -R", after which you should run "START" yourself :)
  235.   Unfortunately this does also overwrite your own additional info.
  236.  
  237.   The option "NOSEARCH" should be used with some caution. Usually, EASYWAD2
  238.   will search all given WADDIR directories for WAD files (and write a
  239.   WADINFOFILE if needed). "NOSEARCH" forces the program to NOT search the
  240.   directories, but to use the WADINFOFILE directly to obtain all WAD file
  241.   statistics. This REALLY speeds up things when using LOADS of WAD files or
  242.   WAD files on cd-rom. The problem comes if you add or delete a WAD file (or
  243.   even a WAD directory). As no directories are scanned, the program will be
  244.   unable to notice the changes, and still display the 'old' list. So, if you
  245.   use this option and change ANYTHING in your filesystem, including deletion
  246.   from within EASYWAD2, be sure to use "EW -R" (or "EASYWAD2 -R") to update
  247.   the WADINFOFILE!
  248.  
  249.  
  250.  
  251. USING A DIFFERENT CONFIGURATION FILE:
  252.  
  253.   The default configuration file is "EASYWAD2.CFG". You can use a different
  254.   file by adding the command line parameter +<new_config_file>. This option
  255.   is particularly useful if you have WAD files on a CD-ROM. You could make a
  256.   configuration file, say "CDWADS.CFG", which contains the following lines
  257.   (assuming that your CD-ROM drive is called E:)
  258.  
  259.   DOOMDIR <your_main_DOOM_directory>
  260.   WADDIR E:\ /S                        # All subdirs from the root
  261.   WADINFOFILE CDWADS.DSC               # Should be different than the normal
  262.   NOSEARCH                             # The CD-ROM never changes contents
  263.   SORTFILES INFO                       # Sort all files by their info field
  264.  
  265.   If you want to access these file, than start with "EW +CDROM.CFG"
  266.  
  267.  
  268.  
  269. REMEMBER:
  270.  
  271.   The program can handle a maximum of 1000 WAD files. 54 files are printed in
  272.   a page on the selection screen. Just click on a 'pager' and the next page is
  273.   displayed. The maximum number of directories is 400.
  274.  
  275.   Notice that you do not have to 'Press return to continue' when you start
  276.   DOOM with a selected WAD file (unless you selected NOAUTORETURN in your
  277.   configuration file).
  278.  
  279.  
  280. Good luck!
  281.  
  282. If you use this program, please drop a note (you like it, you hate it, you
  283. would like things changed) at the following email address:
  284.  
  285. martijn@htsa.hva.nl
  286.  
  287. This program (and its updates) can be freely obtained from anonymous ftp.
  288. Check out the following sites:
  289.  
  290. infant2.sphs.indiana.edu    in the directory /pub/doom
  291. mimosa.astro.indiana.edu    in the directory /pub/doom
  292. bear.montefiore.ulg.ac.be   in the directory /pub/doom
  293.  
  294.  
  295.  
  296. COPYRIGHTS:
  297.  
  298.   This program has NO copyrights whatsoever.
  299.   If it causes any problems ... yeah, right!
  300.   This absolutely freeware program may be edited and distributed at taste.
  301.   The only thing that I ask is to distribute the complete package.
  302.  
  303.  
  304.  
  305. CREDITS GO TO:
  306.  
  307.   - The makers of DOOM (Id Software). They changed my life completely.
  308.   - The makers of DMSPEC13.TXT (Matt Fell & Hank Leukart). This is where I
  309.     found the info on the structure of a WAD file;
  310.   - The makers of DEU (Doom Editor Utility, by Brendon Wyber & Raphael Quinet)
  311.     for their commented source. I use a few of their namings in my source.
  312.  
  313.  
  314.  
  315. ADDITIONAL CREDITS GO TO:
  316.  
  317.   - J.J. Kwast of ThunderWare Research Center. He gave me the constructive
  318.     criticism I needed when he wasn't DEU-ing.
  319.   - B. Castricum for 'play-testing' and giving additional comments.
  320.   - Everyone else who gave reactions.
  321.   - All those people out there that are constantly creating new WAD files.
  322.  
  323.  
  324.  
  325. CONTENTS OF THE EASYWAD2 PACKAGE
  326.  
  327. This package should contain the following files:
  328.  
  329.   EASYWAD2.DOC - Guess what? You're reading it!
  330.   EASYWAD2.EXE - The main thing
  331.   EASYWAD2.CFG - An example configuration file
  332.   EW.BAT       - The usual entrance :)
  333.   EASYWAD2.C   - The source code of this utility
  334.  
  335. If any part is missing, please contact me at the above address to receive the
  336. full copy.
  337.  
  338.  
  339.  
  340. WHAT YOU NEED:
  341.  
  342.   The same stuff as for DOOM ][:
  343.  
  344.   - A PC (minumum is a '386 for DOOM ][ and a '286 for this proggie);
  345.   - A VGA screen;
  346.  
  347.   Extra:
  348.  
  349.   - An initialized mouse (recommended);
  350.   - A few spare sectors on your harddisk.
  351.