home *** CD-ROM | disk | FTP | other *** search
/ Quake 'em / QUAKEEM.BIN / doom_i / program / deciupgr.exe / DOOMEX.DOC < prev    next >
Encoding:
Text File  |  1995-07-16  |  7.6 KB  |  176 lines
  1. DOOMEX - DOOM Resource Export Utility
  2.          Version 1.0 as of 9/1/94
  3.  
  4. NOTICE: The author of DOOMEX, DOOMIM, and DOOMCV will not be held
  5.         responsible for damage or problems that may occur through
  6.         use of this software. You accept full responsibility for
  7.         the consequences of using this software.
  8.                  
  9.  
  10. DOOMEX is part of a collection of 3 utilities used to import, export, and
  11. convert the resource objects in any DOOM WAD file. The other 2 programs in
  12. this set are DOOMCV, for converting modified data files (PCX, WAV, MUS, and
  13. MAP) into raw DOOM resource image files (DRI), prior to reinsertion to a WAD
  14. file, and DOOMIM, the batch import utility.
  15.  
  16. DOOMEX is very simple and very plain. Its job is to extract resources from
  17. a WAD file and convert the data as necessary into individual files. DOOMEX
  18. makes no assumptions about the WAD file, whether it is a PWAD or IWAD, or
  19. whether it is from DOOM or DOOM II. The extracted files can be passed
  20. onto some editing program(s), modifed and then reinserted into an existing
  21. WAD file or a new patch WAD file using DOOMCV and DOOMIM.
  22.  
  23. DOOMEX assumes some knowledge of the entries in the WAD file. For example,
  24. you should be aware that entries that begin with DS are sound sample
  25. resources, entries that begin with D_ are music resources, and entries
  26. contained between x_START and x_END zero length entries can be floor/ceiling
  27. textures, sprites, or wall patches (raw graphic resources). If you wish to
  28. work with level data, editors such as DEU, DOOMCAD, and DOOMED will work
  29. directly with the resource entries for any level. DOOMEX will export map
  30. level entries as numeric matrices with an extenstion of .MAP. You can edit
  31. MAP files like any other DOS text file, and then reinsert the MAP files back
  32. into the WAD file. DOOMEX does not identify any WAD entry name with a
  33. formal description (such as using "Spider Demon" to identify WAD entry
  34. SPIDA1D1). This ensures that new or unknown WAD entries won't confuse
  35. DOOMEX.
  36.  
  37. DOOMEX comes with a small data file called DOOMEX.PAL. This is the default
  38. DOOM color palette using when generating PCX files. If you don't have this
  39. file, use the following procedure to generate the file:
  40.  
  41. doomex doom.wad playpal
  42. ren playpal.dri doomex.pal
  43.  
  44. Don't worry about the file size of the PLAYPAL entry. DOOMEX only needs the
  45. first 768 bytes of data.
  46.  
  47.  
  48. DOOMEX Calling Syntax:
  49.  
  50. DOOMEX [-q] [-c] [-t] [-l[File Name]] [-m] <Wad File> [Entry Name] [Location]
  51.  
  52. 1. Option -q will suppress all screen echoing during execution.
  53.  
  54. 2. Option -c will convert specific entries to an appropriate external format.
  55.  
  56.    If the directory entry is a sound resource, the output file will be
  57.    stored as a .WAV file.
  58.    
  59.    If the directory entry is a music resource, the output file will be
  60.    stored as a .MUS file.
  61.    
  62.    If the directory entry is bounded within a sprite (S_START/E_END) area,
  63.    a wall patch area (P_START/P_END) or a floor/ceiling texture area
  64.    (F_START/F_END), the resource will be stored as a .PCX file.
  65.    
  66.    If the graphic resource is NOT a floor/ceiling texture, another
  67.    file will be created with an extension of .DGH (DOOM graphic header).
  68.    This file contains the width, height, left, and top offsets (insertion
  69.    point) in a 1 line DOS text file. You MUST have this file available for
  70.    conversion of the graphic using DOOMCV. You only need to modify the
  71.    insertion point (top/left offset) if you change the graphic size.
  72.    
  73.    Like the program DMGRAPH, transparent areas will be shown with palette
  74.    entry 247, which is set to CYAN (R=0,G=255,B=255) unless you override
  75.    this with the -t option (see below).
  76.    
  77.    
  78.    If the directory entry does not fit any of the above formats, then the
  79.    resource will be stored as a PCX file ONLY if a valid image header in
  80.    the resource can be located. WARNING! the check for whether a resource
  81.    is an image or just some arbitrary data (such as PLAYPAL) is not
  82.    bulletproof. Make SURE you know that a resource is a graphic image
  83.    before using the -c option (if the resource falls within the sprite or
  84.    texture entry areas, you can be sure that a proper PCX file will be
  85.    generated).
  86.    
  87.    If you specify a map entry for exporting (i.e. E1M1), then the 10
  88.    associated resources for that level (THINGS, SIDEDEFS, LINEDEFS,
  89.    SECTORS, SSECTORS, NODES, REJECT, BLOCKMAP, VERTEXES, SEGS) will be
  90.    dumped as numeric matrices in a file with an extension of MAP. The size
  91.    of this file may be incredibly large (i.e. E2M7 will be more than half
  92.    a megabyte in size). If you want to look at or edit this map file, you
  93.    may choose to do so, but with many easy to use level editors available
  94.    for changing this information, you'd be better off not modifying the
  95.    MAP file.
  96.    
  97.    If you do NOT use option -c, then all entries will be dumped as
  98.    raw image resource files with an extension of .DRI. This is the format
  99.    DOOMIM needs for reinsertion of resources into a WAD file. The file
  100.    size and contents will be exactly as they appear in the WAD file.
  101.  
  102. 3. Option -t will cause the transparent color in the DOOM color palette to
  103. remain black when an image is stored in a PCX file. Without using the -t
  104. option, the transparent color will be changed to cyan so that you can see
  105. what areas of an image show through.
  106.  
  107. 4. Option -l will dump entries in the WAD file to a file that immediately
  108. follows the -l parameter (i.e. use '-ldoomdir.txt', not '-l doomdir.txt').
  109. No export function will be performed in this case. If you do not specify
  110. a directory entry, the entire WAD directory will be dumped. If you do not
  111. specify a file name, the entries will be listed to the screen.
  112.  
  113. 5.Option -m will enable the entry name to be used as a wild card match string.
  114. Matching is done from the first position of a WAD entry name. For example
  115. to extract all player image data, use
  116.  
  117.     doomex -c -m doom.wad play
  118.     
  119. Since player sprites start with a 4 character prefix of 'PLAY', all player
  120. sprites are extracted.
  121.  
  122. As another example, to export all sound samples in a WAD file, use the syntax:
  123.  
  124. doomex -m doom.wad ds
  125.  
  126. Thus, the -m parameter permits you to perform a batch operation on multiple
  127. related resource objects at one time.
  128.  
  129. 6. The location parameter can be used to extract entries that have the same
  130. name (i.e. THINGS entries can occur more than once in a wad). Use the
  131. starting location that is provided in the listing generated with the -l
  132. option. You will rarely, if ever, need to specify the location of the
  133. resource.
  134.  
  135. 7. Exported resources will contain the same name as the directory entry,
  136. unless the entry uses illegal DOS file characters, in which case a warning
  137. will be given. You can override the naming of the exported file name by
  138. following the WAD entry name with a colon and the file name (NO extension).
  139.  
  140. Example: doomex -c doom.wad spida1d1:spider
  141.  
  142. This example will generate 2 files: spider.pcx and spider.dgh. The override
  143. mechansim is NOT valid when extracting a batch of files using the -m option.
  144.  
  145.  
  146.  
  147. Some examples of using DOOMEX follow:
  148.  
  149. doomex -ldoomdir.txt doom.wad
  150. (list entire wad file to doomdir.txt)
  151.  
  152. doomex -m -c doom.wad d_
  153. (export all music resources and convert to MUS format)
  154.  
  155. doomex -t -m -c doom.wad boss
  156.  
  157. (export all BOSS sprites as PCX files, don't change transparent color)
  158.  
  159. doomex doom.wad playpal
  160.  
  161. (export PLAYPAL as PLAYPAL.DRI)
  162.  
  163. doomex -m -c doom.wad f_
  164. doomex -m -c doom.wad s_
  165. doomex -m -c doom.wad p_
  166.  
  167. (export ALL floor textures, sprites, wall patches as PCX files, respectively)
  168.  
  169. Comments/suggestions to:
  170.  
  171. Alan Peters
  172. c/o DarkStar Systems
  173. 71 Wagon Trailway
  174. North York, Ontario
  175. Canada M2J 4V4
  176.