home *** CD-ROM | disk | FTP | other *** search
/ Fraggin / Fraggin.iso / utils / wad1to2 / wad1to2.txt < prev   
Text File  |  1994-11-03  |  10KB  |  245 lines
  1.  
  2.                    *****************************
  3.                              WAD1TO2
  4.                               v1.0
  5.  
  6.                    DOOM1 to DOOM2 PWAD converter
  7.                         by Tracy F. Thonn
  8.                              11/3/94
  9.                    *****************************
  10.  
  11.  
  12.  
  13. [1] BACKGROUND
  14.  
  15. After spending many hours creating a PWAD level for DOOM I to look
  16. exactly like the building where I work, ID released DOOM II.  Since I was
  17. not even finished my building and not about to redraw all those walls,
  18. I decided it would be easier to make a converter program and wrote WAD1TO2.
  19.  
  20. WAD1TO2 simply maps DOOM1 levels, textures, music, and wall patch entries,
  21. that no longer exist, to their DOOM2 counterpart or a close replacement.
  22. The program uses an external text map file(WAD1TO2.MAP), which is customizable,
  23. to input the mapping information.  Alternatively, a map file by a different
  24. name can be specified.
  25.  
  26. By the way, my building is still only about 25% complete (the actual is over
  27. 200,000 sq.ft.).  Also, for those of you "interested in knowing", I'm 32 years
  28. old;  and it's Mr. Tracy (not Miss).
  29.  
  30.  
  31. [2] FILES DESCRIPTION
  32.  
  33. WAD1TO2.EXE...........main program *
  34. WAD1TO2.MAP...........default map file used for conversions *
  35. WAD1TO2.TXT...........this documentation
  36. WAD1TO2.C.............source code for wad1to2.exe
  37. STRUCTS.H.............header file for source code
  38. FILE_ID.DIZ...........description file
  39.  
  40. MAKEMAP.ZIP:
  41.     MAKEMAP.EXE.......program to created starter WAD1TO2.MAP file
  42.     MAKEMAP.C.........source code for makemap.exe
  43.     STRUCTS.H.........header file for source code
  44.     MAKEMAP.MAP.......map created by running makemap.exe from DOOM1/2 drive
  45.     TEXTURE.ALL.......list of all wall texture names for Doom1 and Doom2
  46.     FLOORTXT.ALL......list of all floor/ceiling textures for Doom1 and Doom2
  47.     WPATCH.ALL........list of all wall patch names for Doom1 and Doom2
  48.     SOUNDS.ALL........list of all the sound names for Doom1 and Doom2
  49.  
  50. * only files marked are required to run program
  51.  
  52.  
  53. [3] COPYRIGHT
  54.  
  55. DOOM is a registered trademark of id Software.
  56.  
  57. WAD1TO2 (c) 1994 was created by Tracy F. Thonn.
  58. WAD1TO2 is NOT an id Software product.
  59.  
  60. WAD1TO2 is free and may be used as you wish with this one exception:
  61.  
  62.     You may NOT charge any fee or derive any profit for distribution
  63.     of WAD1TO2.  Thus, you may NOT sell or bundle WAD1TO2 with any product
  64.     in a retail environment (shareware disk distribution, CD-ROM,
  65.     etc.) without permission of the author.
  66.  
  67. You may give WAD1TO2 to your friends, upload it to a BBS, or ftp it to
  68. another internet site, as long as you don't charge anything for it.
  69.  
  70.  
  71. [4] DISCLAIMER
  72.  
  73. WAD1TO2 v1.0 was designed to handle about 90% of the basic PWADs now
  74. circulating, but was tested on only a handful.  So I give no guarantees
  75. of the results, especially with really hacked PWAD files.
  76.  
  77. Use WAD1TO2 at your own risk.  Anything you do with WAD1TO2 is your
  78. responsibility, and not the author's.  Any damage caused to any person,
  79. computer, software, hardware, company, or business by running WAD1TO2 is your
  80. responsibility, and the author will not be liable.
  81.  
  82. If you don't understand these terms, or are not sure of something, or
  83. are afraid something bad might come of using WAD1TO2, don't  use  it!
  84. You are here forewarned.
  85.  
  86. The author of WAD1TO2 will not provide support other than this documentation.
  87.  
  88. The author of WAD1TO2 reserves the right to add or remove any functionality of
  89. the WAD1TO2 software.
  90.  
  91.  
  92. [5] INSTALLATION
  93.  
  94. To install, simply copy both WAD1TO2.EXE and WAD1TO2.MAP into the same
  95. directory from which you wish to run the program.
  96.  
  97.  
  98. [6] USAGE
  99.  
  100. To use WAD1TO2 in it's simplest form, enter the DOS command line as follows:
  101.  
  102.    WAD1TO2 <doom1.wad> <doom2.wad> {-s}
  103.  
  104.    where:
  105.             doom1.wad...input DOOM1 pwad file to be converted
  106.             doom2.wad...output pwad file for use with DOOM2
  107.                    -s...optional switch to convert Shotguns to Super Shotguns
  108.  
  109. For example, to convert myfile1.wad in my DOOM directory to myfile2.wad in the
  110. current directory and convert all shotguns to super shotguns:
  111.  
  112.    WAD1TO2 \doom\myfile1.wad myfile2.wad -s
  113.  
  114. WAD1TO2 will first copy myfile1.wad to myfile2.wad, then convert myfile2.wad
  115. using the WAD1TO2.MAP file. myfile1.wad will be left unchanged.
  116.  
  117.  
  118. [7] MAPPING FILE
  119.  
  120. The mapfile used by WAD1TO2 contains text string pairs.  WAD1TO2 inputs the
  121. information from the mapfile in pairs of text, so each entry must be a
  122.             text1 text2
  123. pair separated by spaces, where text1 and text2 can be at most 8 characters.
  124. text1 is a texture name or PWAD directory entry in the input PWAD to be replaced.
  125. text2 is the texture name or PWAD directory entry that text1 is mapped to.
  126.  
  127. The mapfile is divided into sections with headers to tell WAD1TO2 the type of the
  128. map pairs that follow (up until the next header is reached).  Only the following
  129. described headers are recognized by WAD1TO2:
  130. [level1  level2]   for mapping DOOM1 levels to the counterpart DOOM2 maps
  131. [textur1 textur2]  for mapping DOOM1 wall textures that no longer exist to DOOM2
  132.                    wall textures
  133. [patch1  patch2]   for mapping custom wall patches for DOOM1 that no longer exist
  134.                    to DOOM2 wall patches(like the custom SKY1 patch in FOREST.WAD
  135.                    by Jean-Serge Gagnon) *
  136. [floor1  floor2]   for mapping DOOM1 floor/ceiling textures that no longer exist
  137.                    to DOOM2 floor/ceiling textures
  138. [sound1  sound2]   for mapping custom DOOM1 sound entries that no longer exist
  139.                    to DOOM2 sounds *
  140. [music1  music2]   for mapping replacement DOOM1 music entries to their counterpart
  141.                    DOOM2 music names (like the D_E1M1 music entry in FOREVE.WAD
  142.                    by Kathy Brown) *
  143. [demo1   void2]    for mapping old demo entries to unused entries names so DOOM2
  144.                    (or DOOM1 v1.666) doesn't reject them *
  145. * Note: most basic PWADs don't contain any entries of these types.
  146.  
  147. All other entry pairs that begin with [ are ignored, so comment text PAIRS can
  148. be included like:
  149.     [Wad1to2 Mapfile]
  150.  
  151. So for example the mapfile entries
  152.     [level1  level2]
  153.     E1M1     MAP01
  154.     [textur1 textur2]
  155.     LITE2    LITE3
  156. tell WAD1TO2 to convert the E1M1 level for DOOM1 into the first level for DOOM2,
  157. and replace the LITE2 texture everywhere used to the LITE3 texture.
  158.  
  159.  
  160. [8] WAD1TO2.MAP
  161.  
  162. The provided WAD1TO2.MAP file was generated by running the included program
  163. MAKEMAP.EXE.  MAKEMAP opens the \DOOM\DOOM.WAD and \DOOM2\DOOM2.WAD and extracts
  164. all wall texture names, floor/ceiling texture names, wall patch names, and sound
  165. names.  It then compares those in DOOM1 with those in DOOM2 to find the ones
  166. that no longer exist.  It then creates a mapping entry for each DOOM1 item that
  167. no longer exists by mapping it to a corresponding DOOM2 item with the most
  168. matching first few characters.  It also generates the level and music
  169. mapping entries.  MAKEMAP creates the following files:
  170.     makemap.map  - starter mapfile for use with wad1to2.exe
  171.     texture.all  - list of all wall texture names for Doom1 and Doom2
  172.     wpatch.all   - list of all wall patch names for Doom1 and Doom2
  173.     floortxt.all - list of all floor and ceiling textures for Doom1 and Doom2
  174.     sounds.all   - list of all the sound names for Doom1 and Doom2
  175.  
  176. I then copied MAKEMAP.MAP to WAD1TO2.MAP and made a few changes based on my
  177. preferences.  If after converting a PWAD, you are not satisfied with a certain
  178. texture mapping, the WAD1TO2.MAP entry for that mapping can be customized by
  179. replacing the 2nd texture in the entry with a new DOOM2 texture from column 2
  180. of the texture.all file.
  181.  
  182. Note:  Entries in WAD1TO2.MAP should not be deleted since it contains the items
  183.        that no longer exist in DOOM2 and must be mapped to something new in
  184.        order for the PWAD to work with DOOM2.
  185.  
  186. Note:  WAD1TO2.MAP contains no floor/ceiling or sound mapping entries because
  187.        all of the names used in DOOM1 still exist in DOOM2.
  188.  
  189.  
  190. [9] OTHER USES
  191.  
  192. The mapfile WAD1TO2.WAD was created specifically to convert DOOM1 PWADs for
  193. use with DOOM2.  However WAD1TO2.EXE can be used to make other conversions
  194. in a PWAD by creating a custom mapfile.  To use a custom mapfile, use the
  195. DOS command line:
  196.  
  197.    WAD1TO2 <input.wad> <output.wad> <mapfile.map> {-s}
  198.  
  199.    where:
  200.           mapfile.map...custom mapfile
  201.             input.wad...input pwad file to be converted
  202.            output.wad...output pwad file
  203.                    -s...optional switch to convert Shotguns to Super Shotguns
  204.             ***use -s only for DOOM2 output.wad files***
  205.  
  206. Example 1:  To convert a DOOM1 PWAD level from E1M1 to E3M1, use a mapfile
  207.             with only the following in it:
  208.                                             [level1  level2]
  209.                                             E1M1     E3M1
  210.  
  211. Example 2:  To convert all walls in a PWAD with texture TEKWALL1 to TEKWALL4,
  212.             use a mapfile with only the following in it:
  213.                                             [textur1 textur2]
  214.                                             TEKWALL1 TEKWALL4
  215.  
  216. Example 3:  To convert all floors in a PWAD with texture NUKAGE1 to NUKAGE2,
  217.             use a mapfile with only the following in it:
  218.                                             [floor1  floor2]
  219.                                             NUKAGE1  NUKAGE2
  220.  
  221. Example 4:  To convert a DOOM2 PWAD level from MAP01 to MAP16, use a mapfile
  222.             with only the following in it:
  223.                                             [level1  level2]
  224.                                             MAP01    MAP16
  225.  
  226.  
  227. [10] SUGGESTIONS / COMMENTS
  228.  
  229.              EMAIL:  TracyFT@aol.com
  230.  
  231. P.S.  I don't guarantee a reply, so don't expect it!!!
  232.  
  233.  
  234. [11] CREDITS
  235.  
  236. Matt Fell                                            (matt.burnett@acebbs.com)
  237.      Author of the Unofficial Doom Specs.  Making this program
  238.      would have been impossible if the Specs didn't exist.
  239.  
  240. Colin Reed                                                (colin@argonaut.com)
  241.      Programmer of the great BSP node builder, by which I rely to repair
  242.      the bugs created by other editors' built-in node builders.  His
  243.      source code and structs.h files provided a headstart in creating
  244.      WAD1TO2.
  245.