home *** CD-ROM | disk | FTP | other *** search
/ Crazy Collection 12 / CC-12_1.iso / update / doompack / data.a00 / WADOPT10.ZIP / WADOPT.DOC < prev    next >
Encoding:
Text File  |  1995-06-16  |  9.3 KB  |  254 lines
  1.   ██╗    ██╗  █████╗  ██████╗          ██████╗  ██████╗  ████████╗ ██╗
  2.   ██║    ██║ ██╔══██╗ ██╔══██╗        ██╔═══██╗ ██╔══██╗ ╚══██╔══╝ ██║ Version
  3.   ██║ █╗ ██║ ███████║ ██║  ██║ █████╗ ██║   ██║ ██████╔╝    ██║    ██║   1.0
  4.   ██║███╗██║ ██╔══██║ ██║  ██║ ╚════╝ ██║   ██║ ██╔═══╝     ██║    ╚═╝
  5.   ╚███╔███╔╝ ██║  ██║ ██████╔╝        ╚██████╔╝ ██║         ██║    ██╗
  6.    ╚══╝╚══╝  ╚═╝  ╚═╝ ╚═════╝          ╚═════╝  ╚═╝         ╚═╝    ╚═╝
  7.  
  8.   ────────────────────────────────────────────────────────────────────────────
  9.  
  10.                  »» A New Concept in DOOM .WAD Level Design! ««
  11.  
  12.   ────────
  13.   Contents
  14.   ────────
  15.  
  16.   1.  What is WADOPT?
  17.   2.  How do I use it?
  18.   3.  Other info
  19.   4.  Known Limitations & "Features"
  20.   5.  Future Additions(?)
  21.   6.  Shareware--or is it?
  22.   7.  Author info
  23.   8.  Disclaimer
  24.  
  25.  
  26.   ───────────────────
  27.   1.  What is WADOPT?
  28.   ───────────────────
  29.  
  30.   In brief, WADOPT (short for WAD optimizer) is a handy tool that concatenates
  31.   and/or merge two DOOM, DOOM II, or Heretic WADs together.
  32.  
  33.   "Uh, what good is that?"
  34.  
  35.   Well, put it this way:  I got the idea for this after I designed a level for
  36.   DOOM.  Not long after that I got a hold of DOOM II, and I thought it would
  37.   make a good DOOM II level.  I looked at the end product--two levels, and
  38.   each one had mostly identical resources.  What a waste of space!  So I wrote
  39.   WADOPT to squish the two levels together.  And it worked!
  40.  
  41.   "Okay, so it works.  What's it do?"
  42.  
  43.   WADOPT goes through four processes.  First, it reads the directories of
  44.   two WADS you specify and builds a new master directory in memory.  Second,
  45.   it removes any null entries which some programs create (such as DMGRAPH,
  46.   DMMUSIC, DMAUD, and some others).  Third, it looks for identical resources,
  47.   and if one or more duplicates is found, the extra data is zapped.
  48.   Finally, it builds the new WAD.
  49.  
  50.   "Cool.  Why should I bother?"
  51.  
  52.   There's no rule that says you NEED to bother, but if you design WADs, or you
  53.   just want to save a little space, this is useful.  For example, the first
  54.   WAD I designed this for by itself is 142084 bytes.  With the DOOM II version
  55.   I add another 142084 bytes, most of which is the same junk all over again.
  56.   When I ran it through WADOPT, the merged file is 171356 bytes.  Do the math.
  57.   It's a 40% saving of space!
  58.  
  59.   "Great, where can I get it?"
  60.  
  61.   Considering that this is the doc file for WADOPT, you probably already have
  62.   it.
  63.  
  64.   "Oh, yeah.  Duh."
  65.  
  66.   But in case you're reading this as a promo, or you've misplaced your .EXE,
  67.   try heading off to:
  68.  
  69.   ftp://ftp.cdrom.com/pub/doom/misc
  70.  
  71.   The directory is a guess.  This could be right, or it could be elsewhere.
  72.   I'll find out where v1.0 goes, and I'll try to get it right for future
  73.   versions.
  74.  
  75.   "Thanks."
  76.  
  77.   No problem.
  78.  
  79.  
  80.   ────────────────────
  81.   2.  How do I use it?
  82.   ────────────────────
  83.  
  84.   Making it work is a no-brainer.  Find your local DOS prompt and type:
  85.  
  86.   C:\DOOM> WADOPT MYWAD1.WAD MYWAD2.WAD MYWAD1&2.WAD
  87.          ^
  88.          |
  89.          (That's the prompt--don't type it.)
  90.  
  91.   WADOPT reads "MYWAD1.WAD" and "MYWAD2.WAD" (or whatever your WADs are
  92.   called) and after a couple seconds (maybe longer if you don't hit the return
  93.   key!) it produces "MYWAD1&2.WAD".
  94.  
  95.   Like most DOS programs file name case is not important.  You DO need to put
  96.   the ".WAD" on the end of the file.
  97.  
  98.  
  99.   ──────────────
  100.   3.  Other info
  101.   ──────────────
  102.  
  103.   Two small-to-medium size levels can be merged within about 5 seconds, even
  104.   on a measly 386.  As a rule of thumb, time should increase significantly if
  105.   there are many big, similar resources.
  106.  
  107.   Resources from the first specified input file show up in the new directory
  108.   first.
  109.  
  110.   Also, this program is VERY memory-hungry.  If this becomes a problem, I can
  111.   produce a protected mode version.  Right now, the ceiling seems to be about
  112.   1200 (which really isn't all that bad), give or take a few.
  113.  
  114.   Version 1.0 was written with Borland Pascal 7.0, my language of choice.  If
  115.   there's anyone out there in net-land familiar with C++ and TP, drop me a
  116.   line.  I'd like to have a C++ version so it's portable, but even after
  117.   trying to read the manuals, I still don't quite grasp C++.
  118.  
  119.   This first version is pretty limited, but with a little creativity, you
  120.   can get around it.  If you have textures in the WAD, put them in one WAD
  121.   and the level in another.  You could even use it to design a whole
  122.   Deathmatch episode as a variation on a theme--same level layout, but
  123.   change textures, sector functionality, and linedef triggers.  Send me
  124.   comments, and I'll include them in the docs in later versions!
  125.  
  126.  
  127.   ──────────────────────────────────
  128.   4.  Known Limitations & "Features"
  129.   ──────────────────────────────────
  130.  
  131.   - Currently, the optimizer isn't terribly smart.  It knows what map
  132.     resources are, but it doesn't know about things like P_START, TEXTURE1,
  133.     TEXTURE2, etc.  Future versions will support this.
  134.  
  135.   - It doesn't verify file names.  If one of the input WADs is invalid, it
  136.     will crash gracelessly with a message such as:
  137.  
  138.     Runtime error 002 at xxxx:xxxx.
  139.  
  140.     Don't specify the same name for an input WAD and an output WAD.  It will
  141.     trash the input WAD.
  142.  
  143.   - The ".WAD" extention is currently required.
  144.  
  145.   - All filenames MUST be specified.  If you want to use it to just strip
  146.     out null names, you can kludge it with a little work (for WAD gods):
  147.  
  148.     1.)  Run WADOPT specifying the same WAD for both input files.
  149.     2.)  Load the output WAD into your favorite binary editor.
  150.     3.)  Change the WAD header's count of directory entries to what it's
  151.          supposed to be.
  152.     4.)  Figure out where the first useless entry is, then truncate the file
  153.          there.  The directory is at the end, so nothing is lost.  The place
  154.          to truncate is:
  155.  
  156.            directory_start+16*(new_lump_count)
  157.  
  158.   - Merging a WADs for different versions may cause a little confusion with
  159.     DOOM sites, such as ftp.cdrom.com.  Heck, where do you put a map WAD
  160.     that's for Heretic, DOOM and DOOM II, all at the same time?
  161.  
  162.   - You can merge a Heretic and a DOOM II level with no problem.  If you
  163.     want to merge a DOOM I level with a Heretic level, they need to have
  164.     different level numbers (sorry, I can't control this one).
  165.  
  166.   - With a little patience, you can merge three (or more) WADs by pairing
  167.     off.  For three, process the first two WADs, then process the third and
  168.     the first ouput WAD.
  169.  
  170.   - Trying to edit the WAD is likely to cause at least some havoc on it.
  171.     Some editors may not be able to load it, and just about all of them will
  172.     kill the level(s) you're not editing.  If you try editing a WAD, MAKE
  173.     BACKUPS!!!  I don't have time to experiment with all the editors out
  174.     there, so let me know how a merged WAD works with your favorite editor.
  175.     Hopefully, if this gets popular, we'll get some WADOPT-aware editors.
  176.  
  177.   - I'm only sure these levels work with 1.666 or above.  I have no idea
  178.     what happens if you load it into v1.2 or earlier, and I don't feel
  179.     like reinstalling to find out.
  180.  
  181.  
  182.   ───────────────────────
  183.   5.  Future Additions(?)
  184.   ───────────────────────
  185.  
  186.   - Handling of graphics indicators (S_START/S_END, P_START/P_END, etc.)
  187.  
  188.   - Better file handling/checking
  189.  
  190.   - Ability to remove null nodes only
  191.  
  192.   - Script (response) file for more control over merging (?)
  193.  
  194.   - Ability to merge more than just two WADs at a time
  195.  
  196.   - Any other suggestions?
  197.  
  198.  
  199.   ────────────────────────
  200.   6.  Shareware--or is it?
  201.   ────────────────────────
  202.  
  203.   I spent almost three straight days working on this thing (mostly chasing
  204.   down bad pointers), and I put a lot of effort into making it a good
  205.   program.  Sure, it's rough, and sure, it's not the prettiest, but I hope
  206.   it passes the test and is well-accepted.  It passes all my first-cut tests,
  207.   and I gave it a beating!
  208.  
  209.   You're not obligated to pay me anything, and I can't guarantee any perks if
  210.   you do send me anything, but I certainly wouldn't be against it.  I
  211.   especially like non-US currency and have a collection from a few countries
  212.   (hint, hint).
  213.  
  214.   At least, a little support will let me know my efforts weren't wasted and
  215.   will give me incentive to keep up support and development (for WADOPT and
  216.   other DOOM programs).
  217.  
  218.  
  219.   ───────────────
  220.   7.  Author info
  221.   ───────────────
  222.  
  223.   A little about me:  I'm an independent computer consultant with not enough
  224.   work or money, and far too much free time on my hands.
  225.  
  226.   To drop me a line with suggestions, comments, and what not via e-mail:
  227.  
  228.   sinykal@cyberspace.org
  229.  
  230.   This is my summer address.  After about 26 August '95 try me at:
  231.  
  232.   scott@whiplash.pc.cc.cmu.edu
  233.  
  234.   Or, if you want to get a hold of me by snail mail:
  235.  
  236.   Scott Earnest
  237.   1553 Wilson Road
  238.   Pittsburgh, PA  15236-3626
  239.  
  240.   Also, check out "The Marble Maze" (MARBMAZE.ZIP).  It's the first WAD to
  241.   use this method!
  242.  
  243.  
  244.   ──────────────
  245.   8.  Disclaimer
  246.   ──────────────
  247.  
  248.   This program is released "AS-IS".  All responsibility for any yet un-
  249.   discovered bugs is off my hands if you use this.  At the time of upload to
  250.   the net I guarantee this program is virus free.  After that, all bets are
  251.   off.  Also not responsible for deleted or damaged files caused by misuse.
  252.  
  253.   Blah, blah, blah, and all the rest of the normal legalese crap.
  254.