home *** CD-ROM | disk | FTP | other *** search
/ CD-X 1 / cdx_01.iso / cheat / doomtool / doomed / idbsp.doc < prev    next >
Encoding:
Text File  |  1995-01-17  |  9.9 KB  |  218 lines
  1. -------------------------------------------------------------------------------
  2. Table of Contents
  3. -------------------------------------------------------------------------------
  4.  
  5. 1.0   Introduction
  6.   1.1   Standard Disclaimer
  7.   1.2   Copyright Notice
  8. 2.0   What's new in v1.1
  9.   2.1   Bug fixes
  10.   2.2   New features
  11. 3.0   Hints and tips for using IDBSP
  12. 4.0   Known bugs, limitations, etc.
  13.  
  14.  
  15. ------------------------------------------------------------------------------
  16. 1.0   Introduction
  17. ------------------------------------------------------------------------------
  18.  
  19. This is the documentation for IDBSP11.ZIP, version 1.1 of my port of id's BSP
  20. builder to DOS.  The package consists of two programs, IDBSP.EXE and
  21. WAD_DWD.EXE; full source for both is included.  Hopefully, the source is a
  22. little cleaner in this version, to contrast my uglieness in v1.0.
  23.  
  24. Programs are 32-bit DOS-extended, compiled with DJGPP v1.11m5.  The DOS 
  25. extender (GO32) is prepended to the executable, so no support files (other 
  26. than EMU387 for those without a coprocessor) are required.  Both IDBSP and 
  27. WAD_DWD should be able to handle the largest PWADs without problems, 
  28. provided your machine has sufficient memory (real and virtual).
  29.  
  30. Send comments, requests, etc. to Ron Rossbach at ej070@cleveland.freenet.edu.  
  31. I usually respond within 2 days, except during extended absences from the 
  32. net due to vacations, etc.  Please be patient!
  33.  
  34. Thanks go to (in no particular order):
  35.     - id Software, Inc.
  36.      for developing DOOM and releasing their BSP 
  37.      source
  38.     - Matt Fell (matt.burnett@acebbs.com)
  39.      for developing the Unofficial Doom Specs
  40.     - Colin Reed and Raphael Quinet (colin@argonaut.com and
  41.      quinet@montefiore.ulg.ac.be)
  42.      for developing BSP, the first BSP builder
  43.     - Antony Suter (antony@werple.apana.org.au)
  44.      for providing a "radius" value which corrects id's original "slime
  45.      column" bug
  46.     - Gregg Anderson (cadman@krypton.mankata.msus.edu)
  47.      Beta testing and encouragement
  48.  
  49. along with apologies for anyone I've missed.
  50.  
  51. 1.1   Standard Disclaimer
  52. ===============================================================================
  53.  
  54. This program is provided with NO WARRANTY, though I hope you will find it
  55. useful.  Use at your own risk.  You may not use this code to develop levels 
  56. which work with the shareware version of DOOM.  I assume no responsibility 
  57. or liability, direct or indirect, for the use, misuse, or abuse of this 
  58. program. DOOM and DOOM 2 are registered trademarks of id Software, Inc.  
  59. IDBSP is not a product of id Software, Inc., and id will not provide support 
  60. for this program.
  61.  
  62. It is illegal (not to mention immoral) to distribute the components of
  63. registered DOOM and/or DOOM 2 in either original or modified form.
  64.  
  65. 1.2   Copyright Notice
  66. ===============================================================================
  67.  
  68. IDBSP is copyright (c) 1994 by Ron Rossbach (ej070@cleveland.freenet.edu).  
  69. All rights reserved.  You are granted the following rights:
  70.  
  71. -   You may modify and re-distribute the program, as long as you call it
  72.     something else, and give credit for IDBSP being the basis of your work.
  73.     This includes using the source in your own level editor or other
  74.     derivative work.  You may NOT distribute modified versions of this program
  75.     under its original name.  Submit any suggestions, bug fixes, etc. to Ron
  76.     Rossbach at ej070@cleveland.freenet.edu, and they will be included (with
  77.     full credit) in any future versions of IDBSP.
  78.  
  79. -   You may distribute un-modified versions of the program, under its original
  80.     name, as long as you distribute the original zip file unmodified.  This
  81.     includes utility authors who wish to include IDBSP in their distributions,
  82.     CD-ROM publishers, etc. Simply include the IDBSP zip file in your
  83.     distribution, and all is well.
  84.  
  85. -   If you modify and re-distribute the program, or use the program as a basis
  86.     for a derivative work, you must include the full source code of your work
  87.     (excluding any third-party libraries which prohibit the distribution of
  88.     their source) in your distribution.  This is to uphold the spirit of free
  89.     software and allow others to learn from your work.
  90.  
  91. You are encouraged to build upon this program in your own editors, subject
  92. to the conditions above.  If you would like rights in addition to those
  93. mentioned above, contact Ron Rossbach at ej070@cleveland.freenet.edu. (Don't
  94. worry, I'm not going to charge anything, I'd just like to be able to keep
  95. track of things, that's all....)
  96.  
  97. DOOMBSP.ZIP (id's Objective-C source for the BSP builder) and DOOM itself are
  98. copyright (c) 1993 by id Software, Inc.
  99.  
  100. -------------------------------------------------------------------------------
  101. 2.0   What's new in v1.1
  102. -------------------------------------------------------------------------------
  103.  
  104. Well, several things, actually, aside from the additional legalese and support
  105. for DOOM 2.
  106.  
  107. IDBSP v1.0 was a faithful port of id's original BSP builder, and as such,
  108. behaved differently than the other BSP builders that everyone had gotten used
  109. to.  It required rising staircases to have alternating sector tags as
  110. described in the Unoffical Specs, did not allow multi-extent sectors, and would
  111. align THINGS on a 16x16 grid.  IDBSP v1.1 corrects these while providing access
  112. to most original v1.0 behavior via command line parameters.
  113.  
  114. 2.1   Bug Fixes
  115. ===============================================================================
  116.  
  117. The following v1.0 bugs are fixed in v1.1:
  118.  
  119. - remove alignment of THINGS on a 16x16 grid.  Alignment is no longer 
  120. available.
  121.  
  122. - a new EMU387 is provided, which actually works.
  123.  
  124. - v1.0 would print a message saying it was removing duplicate lines, while
  125.   leaving the lines in the level.  Now the lines really ARE removed when IDBSP
  126.   says they are.
  127.  
  128. - the "slime column" bug was fixed by using a value of 1.4143 in the radius
  129.   calculations in function PointOnSide (thanks to Antony Suter to 
  130.   contributing this).  Use a radius of 2.0 to retain the original 
  131.   PointOnSide behavior.
  132.  
  133. - both WAD_DWD and IDBSP v1.0 had problems handling zero-length WAD resources,
  134.   like P_START.  This is fixed.
  135.  
  136. - WAD_DWD had a string overwrite bug.  This is fixed.
  137.  
  138. - WAD_DWD would choke on a NULL resource, which DEU likes to include as the
  139.   last entry in the WAD directory.  This is fixed.
  140.  
  141. 2.2   New Features
  142. ===============================================================================
  143.  
  144. IDBSP v1.1 includes the following new features:
  145.  
  146. - the DWD format has been further extended to include a "sectors:" section at
  147.   the beginning of each level.  DWD files created by WAD_DWD v1.0 will not work
  148.   with IDBSP v1.1.  An updated WAD_DWD is included, but since IDBSP v1.1 can
  149.   now use a WAD file as input, this extra step is no longer required.  The 
  150.   DWD format IS useful for picking apart levels with a standard text editor, 
  151.   though.
  152.  
  153. - support for a selectable level of sector handling (see below)
  154.  
  155. - support for DOOM2 (DOOM II, DOOM ][, DOOM HOE, or whatever)
  156.  
  157. - IDBSP can now use a WAD file as input, so the DWD step is not necessary (see
  158.   below)
  159.  
  160. - New command-line parameters:
  161.  
  162. The new command-line syntax is:
  163. "idbsp [-fullreject | -radius=x | -sectopt=x | -duplines | -trace] [-wad]
  164.     infile [outfile]"
  165.  
  166. Parameters may be included in any order, anywhere on the command line, with 
  167. the exception of the -wad parameter.
  168.  
  169. -fullreject
  170.      Includes all sectors in the REJECT calculations.  By default, small
  171.      sectors (less than 64x64) are excluded from these calculations.
  172.  
  173. -radius=x
  174.       Specifies a new value for radius in the PointOnSide function.  Default  
  175.       is 1.4143, contributed by Antony Suter.  id's original default is 2.0.  A
  176.       radius of 2.0 will sometimes cause the "slime column" bug, while a 
  177.       radius of 1.4143 usually fixes this bug but may cause some sectors to 
  178.       be grouped incorrectly when used in conjunction with -sectopt=1.  
  179.       Experiment to find values that best suit your own levels.
  180.  
  181. -sectopt=x
  182.       Selects the level of sector handling.  Valid values are 0 or 1.  A value
  183.       of 0 (the default) simply leaves sectors alone.  A value of 1 will
  184.       regroup sectors as in IDBSP v1.0.  "Regroup" means:  as sectors are 
  185.       read in from the DWD (or WAD) file, any duplicates are removed; hence 
  186.       the need for alternating sector tags on rising staircases when 
  187.       -sectopt=1.  This yields an "intermediate" list of sectors.  The final 
  188.       sector list is built by creating completely enclosed, single-polygon 
  189.       sectors by walking through the SEG list.  Hence the lack of support 
  190.       for "multi-extent", or multi-polygon, sectors when -sectopt=1.
  191.  
  192. -duplines
  193.       Allows duplicate and zero-length linedefs to be retained in the WAD 
  194.       file. By default, duplicate and zero-length linedefs are removed.  
  195.       Note that IDBSP will consider two linedefs to be duplicates if they 
  196.       are within 8 pixels of each other, due to floating point inaccuracy.
  197.  
  198. -trace
  199.             
  200.       Displays debugging and tracing information while IDBSP is running.
  201. -wad
  202.       Allows input directly from a WAD file, rather than a DWD file.  Default
  203.       is still a DWD file. This parameter must immediately proceed the name of
  204.       the WAD file on the command line.  For example:
  205.  
  206.       "idbsp -wad input.wad -radius=2.0 output.wad"
  207.  
  208. -------------------------------------------------------------------------------
  209. 3.0   Hints and Tips for using IDBSP
  210. -------------------------------------------------------------------------------
  211.  
  212. 1)  IDBSP reports removal of duplicate lines, but the lines aren't duplicated,
  213.     just real close together.......solution? Run IDBSP with the -duplines
  214.     parameter to suppress the removal of duplicate and zero-length lines.
  215.     IDBSP thinks that any lines within 1 map unit (4 pixels) of each other are
  216.     duplicates, due to floating-point inaccuracies.
  217.  
  218.