home *** CD-ROM | disk | FTP | other *** search
/ The Complete Doom Accessory Pack 4 / TheCompleteDoomAccessoryPackVolumeIvCd.bin / miscutil / wadmastr / wm.doc < prev    next >
Text File  |  1994-12-03  |  9KB  |  188 lines
  1.   ┌───────────────────────────────────────────────────────────────────────┐
  2.   │ ┌───────────────────────────────────────────────────────────────────┐ │
  3.   │ │                          WAD Master v.9                           │ │
  4.   │ │                      Doom 2 WAD File Utility                      │ │
  5.   │ └───────────────────────────────────────────────────────────────────┘ │
  6.   └───────────────────────────────────────────────────────────────────────┘
  7.         
  8.         1. Quick Start                  1. Pronto el Comenzar
  9.         2. What will it do?             2. ¿Qué legar la hacer?
  10.         3. How to use it                3. Cómo hasta usar ella
  11.         4. Bugs  :(                     4. El Cucaracha  @ß^(  
  12.         5. Acknowledgements             5. Reconocimiento
  13.                                         
  14.  
  15.         1. Quick Start
  16.         --------------
  17.         1. Unpack the WADMASTR archive into any directory.
  18.         2. Make sure the following files are present:
  19.             GENMIDI.OP2 - This is needed to listen to the music on 
  20.                           the SoundBlaster
  21.             WM.EXE      - The WAD Master main program
  22.             WM.DOC      - What you're reading
  23.             WM.INI      - The initialization file for WAD Master
  24.             FILE_ID.DIZ - Archive describer
  25.             If you are missing the WM.INI file: Use your favorite 
  26.             text editor and create a file called WM.INI.  This file 
  27.             should only contain 1 line and that should be the full 
  28.             name of the main DOOM2 WAD (IWAD) file (usually DOOM2.WAD).  
  29.             This line can also include a drive/path specification 
  30.             (eg: C:\DOOM2\DOOM2.WAD).
  31.         3. At the DOS prompt, change to the directory containing 
  32.             WAD Master.
  33.         4. Type WM at the DOS prompt.  Hit ENTER/RETURN.
  34.         
  35.  
  36.         2. What will it do?
  37.         -------------------
  38.         WAD Master can perform the following tasks:
  39.         1. Import/export any entry to and from WAD files.
  40.         2. Import/export sprites/graphics to and from PCX or raw
  41.             type files.
  42.         3. Import/export music to and from MUS type files.
  43.         4. Import/export sound to and from WAV or raw type files.
  44.             (there is a known bug with the WAV exporter, but I'm
  45.             workin' on it :) )
  46.         5. Import/export miscellaneous raw files. (palette, end doom 
  47.             screen, etc...)
  48.         6. Display all sprites, wall, floor & ceiling textures.
  49.         7. Play all music & sound effects. (there is a known bug
  50.             with the DMA transfers - workin' on it)
  51.         8. Repair badly structured WAD files. (the program will
  52.             automatically attempt to repair badly structured
  53.             WADs as they are loaded)
  54.         9. Pack WAD files. (removes deleted entries or unused 
  55.             data from WAD files saving disk space)
  56.  
  57.  
  58.         3. How to use it
  59.         ----------------
  60.         The first thing to appear after you run WAD Master is
  61.         a command prompt (unless initialization of the main WAD
  62.         file fails).  From this command prompt you can read WAD
  63.         files, create new WAD files, switch to edit mode, list
  64.         the directory of a WAD file, pack WAD files, or get a
  65.         list of WAD files in the current directory.  HELP is
  66.         available by using the "?" command (or any other un-
  67.         recognized command).
  68.  
  69.         Command Overview:
  70.         -----------------
  71.         .WAD extension is assumed if not specified in <wadfile>
  72.         (if <wadfile> is not specified, you will be prompted to 
  73.         enter the filename) 
  74.  
  75.         R <wadfile> - Read WAD file.  Reads the directory of the
  76.                       WAD file specified in <wadfile>, and sets
  77.                       up the file to be edited, listed, or packed.
  78.         E <wadfile> - Edit WAD file.  Reads <wadfile> and switches
  79.                       to edit mode.
  80.         C <wadfile> - Creates a new WAD file.  After the new WAD
  81.                       file is created, it will be read in. If 
  82.                       <wadfile> exists, you will be prompted to
  83.                       overwrite the existing file.
  84.         P <wadfile> - Pack WAD file.  Packs the currently loaded
  85.                       WAD file TO the file specified in <wadfile>.
  86.                       If no WAD file is loaded, you will be 
  87.                       prompted to enter the WAD file to pack. If 
  88.                       <wadfile> exists, you will be prompted to
  89.                       overwrite the existing file.
  90.         L <listfile>- List directory of loaded WAD file TO 
  91.                       <listfile>.  Creates a plain text file with
  92.                       a list of loaded WAD's directory.  If no
  93.                       WAD file is loaded, you will be prompted to
  94.                       enter the WAD file to list.  If <listfile>
  95.                       exists, it will be overwritten.
  96.         U           - Unload loaded WAD file (if any).
  97.         S           - Shows the name of the loaded WAD file (if 
  98.                       any).
  99.         D           - Displays a directory of WAD files in the 
  100.                       current directory.  Equivalent of DIR *.WAD
  101.         ?           - Displays the HELP screen.  
  102.         Q           - Quits WAD Master.
  103.  
  104.         Editor Overview:
  105.         ----------------
  106.         UP/DOWN (arrows) - Move the selection bar up or down 1 entry.
  107.         PGUP/PGDN        - Move the selection bar up or down 20
  108.                            entries.
  109.         HOME/END         - Move the selection bar to the top or
  110.                            bottom of the directory.
  111.         INSERT           - Inserts a new entry in the WAD directory.
  112.         DELETE           - Deletes the selected entry. (the entry's
  113.                            resource data will not be removed from the
  114.                            WAD file until a pack has occured)
  115.         ENTER            - Edit the selected entry's name.
  116.         M                - Mark the selected entry and move the 
  117.                            selection bar down 1 entry.  Also used to
  118.                            unmark a single entry.
  119.         U                - Unmark ALL marked entries.
  120.         SPACE            - Activate resource.  This command behaves
  121.                            differently depending on the type of 
  122.                            resource.  Sprite/graphics entries are
  123.                            drawn on the screen, sound/music entries
  124.                            are played over the SoundBlaster, etc...
  125.                            (the entry type is displayed in the lower
  126.                            righthand corner of the status bar.  If
  127.                            the entry type is "[general]", then the
  128.                            entry has no action and this command does
  129.                            nothing)
  130.         F/CTRL-F         - Find entry name.  The F command performs
  131.                            a "fuzzy" search, while the CTRL-F command
  132.                            performs an exact search.
  133.         I/E              - Import/export to or from type.  Depending
  134.                            on the resource type, this command behaves
  135.                            differently.
  136.         ALT-I/ALT-E      - Import/export to or from a raw file.
  137.         CTRL-I/CTRL-E    - Import/export to or from another WAD file.
  138.         CTRL-S           - Shell to DOS.
  139.         F1               - Help.
  140.         Q/ESC            - Quit edit mode.
  141.  
  142.  
  143.         4. Bugs
  144.         -------
  145.         This is not a full release of the program.  Known bugs DO
  146.         exist.  The existing ones do not seem fatal, but can be 
  147.         annoying.  The bugs found are:
  148.  
  149.         1. Sometimes locks up during or after playing a sound 
  150.             effect.  Usually works fine.
  151.         2. Very seldom exports a graphic entry to a PCX
  152.             file incorrectly.
  153.         3. WAV files are not exported correctly.
  154.         4. You can sort of use WAD Master to work with DOOM 1, but 
  155.             there could be problems because some of the entries
  156.             in the DOOM 1 WAD file are named different.
  157.  
  158.         There are other parts of the program that just do not work.
  159.         These are not bugs, I just havent gotten around to 
  160.         implementing them yet.  Hopefully, I will soon have every-
  161.         thing going and working correctly.
  162.  
  163.         If you have a problem other than the ones listed here,
  164.         please report it.
  165.  
  166.         Thanks for using WAD Master!
  167.           
  168.           PROGRAMMING, BODYBUILDING, & SLEEPING LATE:
  169.             Eric Sargent (esargent@whale.st.usm.edu)
  170.           
  171.           IDEAS, EXTENSIVE TESTING, & PHILANTHROPY:
  172.             Mark A. Klem (mark.klem@swcbbs.com)
  173.  
  174.  
  175.         5. Acknowledgements
  176.         -------------------
  177.         Thanks to Mike Tedder for SB DSP and DMA routines.  All
  178.         SB sound effects in WAD Master use Mike's library 
  179.         SBLIB v1.0.  Mike can be reached at:
  180.         tedder@vsl.ist.ucf.edu
  181.  
  182.         Thanks to Vladimir Arnost for his MUS file player and 
  183.         MUS file format docs.  All music heard in WAD Master 
  184.         is from Vladimir's MUSPLAY routines.  Vladimir can be 
  185.         reached at:
  186.         xarnos00@dcse.fee.vutbr.cz
  187.  
  188.