home *** CD-ROM | disk | FTP | other *** search
/ Tricks of the DOOM Programming Gurus / Tricks_of_the_Doom_Programming_Gurus.iso / bonus / utils / wadinfo / wadinfo.doc < prev    next >
Encoding:
Text File  |  1995-03-12  |  7.0 KB  |  205 lines
  1. DOOM WADinfo v1.04 by M. van der Heide of ThunderWare Research Center
  2. Release date: September 12, 1994
  3.  
  4. This program was originally intended for internal use only, but a lot of
  5. people wanted to have it too, so, it grew to be a general purpose utility.
  6. It is used to get all possible information from a WAD file.
  7.  
  8.  
  9.  
  10. LET'S GET STARTED:
  11.  
  12.   Start the program with the command "WADINFO <WADfile>".
  13.   You will seen a screen with the following items:
  14.  
  15.   - The Filename :)
  16.   - The Wadfile type (PWAD or IWAD);
  17.   - The Directory start offset;
  18.   - The Directory size (number of entries);
  19.   - A (magenta) block:
  20.  
  21.     New Colors      : (Yes or -)
  22.     New Demos       : (Demo numbers or -)
  23.     New Sounds      : (Yes or -)
  24.     New Instruments : (Yes or -)
  25.     New Music       : (Yes or -)
  26.     New Sprites     : (Yes or -)
  27.     New Status bar  : (Yes or -)
  28.     New Menu items  : (Yes or -)
  29.     New Graphics    : (Yes or -)
  30.     New Levels      : (The levels or -)
  31.                        e.g. E1M1   means:  episode 1, level 1;
  32.                             E1M1,3 means:  episode 1, levels 1 and 3;
  33.                             E1M1-3 means:  episode 1, levels 1 through 3;
  34.                             E1-    means: complete episode 1.
  35.  
  36.   - If there are new levels in this file, then you see on the right half:
  37.  
  38.     - The level number;
  39.     - The number of player starts; this determines the number of players
  40.       that can play cooperatively in multiplayer mode. If it is 0, then
  41.       it can only be played in deathmatch mode;
  42.     - The number of deathmatch starts; this determines the number of players
  43.       that can theoretically play in multiplayer deathmatch mode;
  44.     - The number of weapons found in this level per skill type:
  45.       D12 means skill 1 and 2;
  46.       D3  means skill 3;
  47.       D45 means skill 4 and 5;
  48.       MUL means number of weapons in multiplayer mode;
  49.       The weapon names are preceded by their number-when-playing;
  50.     - The number of enemies found in this level per skill type (see above).
  51.  
  52.   Now, press one of the following keys (as shown on screen):
  53.  
  54.   'Q'   (Q)uit;
  55.   'N'   see (N)ext level;
  56.   'P'   see (P)revious level;
  57.   'I'   toggle (I)nfo type;
  58.   'C'   (C)heck this level;
  59.   'V'   (V)iew this level;
  60.   'R'   list the new sp(R)ites;
  61.   'S'   list the new (S)ounds;
  62.   'M'   list the new (M)usic;
  63.   'U'   list the new men(U) items;
  64.  
  65.  
  66.  
  67. THE INFO TYPE
  68.  
  69.   Pressing 'I' toggles the info type. Two kinds of info are generated:
  70.   the one descibed in "LET'S GET STARTED" (the default info), and the
  71.   map statistics:
  72.  
  73.   - THINGS   (start, size and number of THINGS between brackets);
  74.   - VERTEXES (start, size and number of VERTEXES between brackets);
  75.   - LINEDEFS (start, size and number of LINEDEFS between brackets);
  76.   - SIDEDEFS (start, size and number of SIDEDEFS between brackets);
  77.   - SEGS     (start, size and number of SEGS between brackets);
  78.   - SECTORS  (start, size and number of SECTORS between brackets);
  79.   - SSECTORS (start, size and number of SSECTORS between brackets);
  80.   - NODES    (start, size and number of NODES between brackets);
  81.              The number of NODES should be 1 less then the number of
  82.              SSECTORS.
  83.   - REJECT   (start, size);
  84.   - BLOCKMAP (start, size);
  85.   - map specifics
  86.  
  87.  
  88.  
  89. CHECK LEVEL
  90.  
  91.   Pressing 'C' checks the currently displayed level. The following (simple)
  92.   checks are made:
  93.  
  94.   - All LINEDEFS have a length of > 0;
  95.   - All LINEDEFS use existing SIDEDEF numbers;
  96.   - All LINEDEFS use existing VERTEX numbers for Start and End values;
  97.   - The BLOCKMAP start is <= lowest VERTEX number;
  98.   - The number of blocks in the BLOCKMAP is enough to fit the map;
  99.   - All blocks contents in the BLOCKMAP start with 0x0000 and end with 0xFFFF;
  100.   - All used LINEDEFS in the BLOCKMAP exist;
  101.   - All used LINEDEFS in a block of the BLOCKMAP are indeed in the block
  102.     (starting, ending or crossing);
  103.   - The length of the REJECT data is ((number_of_SECTORS ^ 2) / 8), rounded
  104.     upwards.
  105.   - All THINGS have valid coordinates;
  106.   - All THINGS have valid angles of appearance;
  107.   - All THINGS are of known type;
  108.  
  109.  
  110.  
  111. VIEW LEVEL
  112.  
  113.   Pressing 'V' views the currently displayed level. The following colors
  114.   have been used:
  115.  
  116.   Secret doors                                : Dark green;
  117.   Regular doors (you must 'press the door')   : Yellow;
  118.   Level 'enders'                              : Light magenta;
  119.   All other switches                          : Light blue;
  120.   Regular walls                               : Dark red;
  121.   Windows etc (both upper and lower unpegged) : Brown;
  122.   All others                                  : Dark grey.
  123.  
  124.  
  125.  
  126. LIST NEW THINGS
  127.  
  128.   If you press 'R', 'S', 'M' or 'U', you get a list of the new things.
  129.   Each entry is preceded (in a darker color) by the type of thing.
  130.   If sounds are listed, then this is the 'sound number', as used in, for
  131.   example, the exellent program "DMAUD".
  132.   The things themselves are described, as the name itself does not tell you
  133.   so much.
  134.  
  135.  
  136.  
  137. Good luck!
  138.  
  139. If you use this program, please drop a note (you like it, you hate it, you
  140. would like things changed) at the following email address:
  141.  
  142. martijn@.htsa.hva.nl
  143.  
  144.  
  145.  
  146. COPYRIGHTS:
  147.  
  148.   This program has no copyrights whatsoever.
  149.   This absolutely freeware program may be edited and distributed at taste.
  150.   The only thing that I ask is to distribute the complete package.
  151.  
  152.  
  153.  
  154. CREDITS GO TO:
  155.  
  156.   - The makers of DOOM (Id Software). They changed my life completely.
  157.   - The makers of DMSPEC12.TXT (Matt Fell & Hank Leukart). This is where I
  158.     found the info on the structure of a WAD file;
  159.   - The makers of DEU (Doom Editor Utility, by Brendon Wyber & Raphael Quinet)
  160.     for their commented source. I use a few of their namings in my source.
  161.     (defines THING_..., fieldnames in structures).
  162.  
  163.  
  164.  
  165. ADDITIONAL CREDITS GO TO:
  166.  
  167.   - J.J. Kwast of ThunderWare Research Center. He gave me the constructive
  168.     criticism I needed when he wasn't DEU-ing.
  169.   - All those people out there that are constantly creating new WAD files.
  170.  
  171.  
  172.  
  173. CONTENTS OF THE WADINFO PACKAGE
  174.  
  175. This package should contain the following files:
  176.  
  177.   WADINFO.DOC - This file
  178.   WADINFO.EXE - The program
  179.   WADINFO.C   - The source code of this utility
  180.  
  181. If any part is missing, please contact me at the above address to receive the
  182. full copy.
  183.  
  184.  
  185.  
  186. NOTE FOR AMIGA USERS
  187.  
  188.   This program can be used on either a PC or an Amiga, without any change
  189.   needed.
  190.   Amiga users should unzip the file "WADINFO.ZIP" on their Amiga. They can
  191.   also get all WAD file information they want, WITHOUT THE NEED TO CONVERT
  192.   THE WADFILE FIRST!
  193.   What you need is very simple:
  194.  
  195.   - Any Amiga;
  196.   - Any chipset (OCS, ECS or AGA, AAA(?));
  197.   - At least Kickstart 2.0x;
  198.   - At least 500 Kb (chip) memory.
  199.  
  200.   Multi-tasking is still possible when using this program.
  201.  
  202.   If you want to change to program, note that the source is in 132 columns,
  203.   so you will probably want to choose the screenmode SUPERHIRES (ECS, AGA).
  204.   To compile the program, uncomment the line '#define _AMIGA_'
  205.