bsp2wrl V1.3 - Quake BSP to VRML Converter
------------------------------------------

By Patrick McCormick (pmccormi@mit.edu) 
and Anthony Accardi (accardi@mit.edu)

FILES
-----

bsp2wrl.txt aka README - this file
bsp2wrl-win32-v13.zip  - Win32 version
bsp2wrl-linux-v13.zip  - Linux version
bsp2wrl-irix-v13.zip   - IRIX version
bsp2wrl-sun4-v13.zip   - Sun version


INTRODUCTION
------------

This is a Quake BSP to VRML (and OpenInventor) conversion utility. It
should work for most Quake levels. It outputs conformant VRML 1.0, VRML
2.0, and OpenInventor files.

The texture dump option of bsp2wrl only outputs PPM files. The excellent
PBMPLUS toolkit (widely available) can be used to convert all your PPM
textures to any format you desire. We have included two Perl scripts which
can be used for this purpose, "allppmtogif" and "allppmtorgb". They blindly
convert all PPM files to GIF or RGB files of the same name.

If you have comments or suggestions, please send them to us at
bsp2wrl@mit.edu.

Please check our web page at http://web.mit.edu/pmccormi/www/bsp2wrl/
for updates.

USAGE
-----

Syntax: bsp2wrl [options] bspfile <wrlfile>
        -h      Help Screen
        -d      Dump Texture Files in PPM format
        -b x0 y0 z0 x1 y1 z1    Only convert polygons inside bounding box
        -i      Write OpenInventor File
        -1      Write VRML 1.0 File
        -n      No textures
        -m      Use materials
        -l      No lights
        -x      Include textured Trigger boxes
        -e <extension>  Specify extension for textures (default "gif")

Options have to come before the filenames. If a wrlfile is not given, the
default is the same as bspfile with the BSP extension replaced by WRL (or
IV).

-d	Dump all textures in PPM format. Use a batch conversion utility
	like the PBMTOOLS or JASC Batchmaster (http://www.jasc.com/) to
	convert them to the GIF format.

-b	Only output nodes in the given bounding box. Useful for making
	(slightly) smaller VRML files. The coordinates are in Quake
	worldspace.

-i	Write OpenInventor output.

-1	Write VRML 1.0 output.

-n	No textures. If you specify -d, it will still dump the textures 
	anyway. (The default is to use textures.)

-m	Add materials. (The default is to not use materials.)

-l	No lights added. (The default is to use lights.)

-x	Include textured Trigger boxes. The default is to leave
	the triggers out entirely.

-e	Specify extension for textures. This is for those who want to
	convert the PPM files to a different format instead of the 
	usual GIF for VRML and RGB for Inventor. It DOES NOT convert
	the PPM files to that particular format, however. This is
	a convenience so that you do not have to manually edit the
	resulting file to use the graphic filename extensions which you
	are using.

EXAMPLES
--------

For example, to convert e1m1.bsp to e1m1.iv (Inventor output)
and dump all the textures to disk, type:

bsp2wrl -d -i e1m1.bsp e1m1.iv

To convert e1m7.bsp to e1m7-2.wrl (VRML 2.0 output) with materials
but no textures, type:

bsp2wrl -n -m e1m7.bsp e1m7.wrl

NOTES
-----

The file "palette.lmp" must be in the current directory if you want to dump
textures. One is included with the distribution. It came from the "gfx.wad"
file in the standard Quake ID0.PAK file.

Using textures and materials simultaneously is possible, but makes the
scene look pretty ugly since most browsers try to combine the two.


CHANGES
-------

V1.0 (not publicly released)

* Wrote bsp2wrl, made it output OpenInventor, VRML 1.0.
* Added texturing, lights, viewpoints.

V1.1 (not publicly released)

* Added VRML 2.0 support.

V1.2

* Added many command line options, added material support.

V1.21

* Fixed bug in camera positioning. 

V1.3

* Fixed bugs with OpenInventor output and the "no textures" option.
* Set defaults to VRML 2.0 and no materials, since mixing materials and
  textures had an ugly effect with browsers such as CosmoPlayer.