YBSP(6)

NAME
ybsp - node builder for Doom wad files

SYNOPSIS
ybsp [options] [-o file] file

ATTENTION
This (ybsp) is BSP 2.3 with the following changes:
- includes man page written by Udo Munk and André Majorel,
- includes automatic disabling of whirling baton if piped,
- includes Colin Phipps' fix for the bugs in bsp23bug.zip,
- renamed to ybsp to avoid collision with xwadtools. This version of BSP is NOT quite the same as the one that comes with Xwadtools or the one you would get by compiling bsp23x.zip. It is not the same as bsp30x.zip either. Xwadtools' BSP has the -noprog option. Zdoom's BSP has support for Hexen. Yadex's BSP has Colin's bugfix and automatic disabling of progress indicator. Please bear with us until we get our acts together and release a common version that includes all the above (and more ?).

DESCRIPTION
BSP builds the node and blockmap resources for a level map in a wad file. Level maps created with level editors and level compilers won't run without this resources build by a node builder. The program supports multilevel building, means it automatically builds the resources for all levels found in the input wad file.

If the program is used without the -o option it will create an output wad file with the name tmp.wad.

BSP has some special effect features:

If a linedef has a sector tag >= 900, then it is treated as "precious" and will not be split unless absolutely necessary. This is good to use around borders of deep water, invisible stairs, etc.

Furthermore, just for a grin, if the linedef's tag is 999, then the sidedef's x-offset set an angle adjustment in degrees to be applied—you can look straight at a wall, but it might come right at you on both sides and "stretch".

BSP supports HOM-free transparent doors. Simply make the sector referenced by the doortracks have a sector tag of >= 900. No need to remember sector numbers and type them in on a command line—just use any sector tag >= 900 to permanently mark the sector special.

OPTIONS

-factor number
    Changes the cost assigned to seg splits. Factor can be any positive integer, and the larger the factor, the more costly seg splits are. A factor of 17 is the default and behaves just like earlier versions of BSP. Changing the factor can sometimes prevent visplane overflows in wads. But then again, some wads have just too many visplane overflows, experiment with the -factor option before giving up.

-noreject
    Does not clobber already existing reject map.

-o file
    Write output to file instead of tmp.wad.

-thold number
    Threshold for visplane overflow. May be used to report more potential visplane overflows if the -vpwarn or -vpmark options estimate too few visplanes. Default threshold is 128.

-vp Attempts to prevent visplane overflows without loss of detail. Using the option causes node line picker to choose node lines in a way that is empirically known to reduce or eliminate visplane overflows.

-vpmark
    Marks visplane overflows with player starts. It's a good idea to write to a separate output file when using this option! One can use an editor then, play each alternate player start, and see if each one causes visplane overflows, and then remove it. Usually no-clipping must be used, at least to step out of walls, since it inserts player starts without regards to collisions, and it uses walls as a basis for visplane calculation.

-vpwarn
    Warns about potential visplane overflows.

BUGS
Will only work on little endian systems. We should integrate Randy Heit's modifications to handle Hexen format wads.

AUTHOR
BSP was written by Colin Reed and Lee Killough (killough@rsn.hp.com). André Majorel did the Unix port and wrote the man page based on the one written by Udo Munk. Colin Phipps contributed bug fixes.

SEE ALSO
idbsp(6), warm(6), wreject(6), xwadtools(6)
The Unofficial Doom Specs by Matthew S Fell.
bsp23x.txt
http://www.teaser.fr/~amajorel/doom/bsp23bug.zip
http://lxdoom.linuxgames.com/notes.html#bsp

BUGS/ERRORS
This program will NOT built a reject map, it will build a zero-ed one, where every sector is visible from any other sector, or with the appropriate option it won't touch an existing reject map. So if this node builder is used the WAD reject resource should be build with other tools.

AUTHOR
Bsp was written by Colin Reed and Lee Killough (killough@rsn.hp.com), based on the node builder included in DEU5 by Raphael Quinet (Raphael.Quinet@eed.ericsson.se).

Linux port was done by Andre Majorel (amajorel@teaser.fr).

Port to other UNIX flavors and some minor modifications by Udo Munk (um@compuserve.com)

Big endian support for Solaris SPARC done by Oliver Kraus (kraus@lw010.e-technik.uni-erlangen.de)

Disabling progress indicator if stderr redirected done by Andre Majorel (amajorel@teaser.fr).

Two bug fixes done by Colin Phipps (cph@lxdoom.linuxgames.com).