BspBuild Help File

Program    : BspBuild.exe
Author     : Tony Browneller  
Date       : 8/31/97
Written in : Visual Basic 5.0
Version    : 0.12
Email      : bspbuild@aol.com
Home Page  : http://bspbuild.telefragged.com/bspbuild

Alright folks, here is a brief explanation of what BspBuild is, does, doesn't do, and why
I wrote it.

What is BspBuild?

BspBuild is a frontend utility that simply makes a batch file. A batch file that calls 
the neccesary utilities to compile Quake levels, and launch Quake.

What Does BspBuild Do? 

It gives the user a graphical display of most of the available options for calling Qbsp,
Light, Vis and a few important Quake options as well. 
Bsp (the best editor) calls BspBuild from the menu as of Version 0.75. The only requirement
is that BspBuild must be in the same directory as Bsp. 

What Can't BspBuild Do?

It doesn't compile the levels, it merely makes a batch file and executes it. I do not
claim to be an expert on all of the available parameters for any of the utilities or
Quake so BspBuild has very little error checking right now. As I get feedback I will 
improve that feature.

Why Did I Write BspBuild?

After using Bsp (The Best Quake Editor) for about 3 months, I grew tired of editing the
bat files to change the way it was being compiled. I wasn't satisfied with the 6 standard
bat configurations that come with BSP, I wanted to do it all! So I sat down and figured
out all of the available parameters that were used by Qbsp/Light/Vis and added a couple
that I used for Quake. I thought about doing a menu bat file routine but that was really
lame. Windows 95 was the deal, so I bought Visual Basic and made what you have in your 
dirty little hands. I do not blame Yahn Bernier (Author of BSP), I just hope to give him
a hand. Taking care of the mundane stuff while he piles out the editor.

Techincal Info

If all else fails, run RemBBReg.exe. It removes BspBuild from the Windows 95 registry. So
you will have to run setup again.
BspBuild uses the Windows 95 registry so you can run it from anywhere.

How Do I use BspBuild? 

  QuickStart :
    After completing the setup procedure, click the hammer (Build). This launches the bat
    file using the default Full bat method. Don't want to run Full? Then click the down arrow 
    and select Fast. All options are now set for a Fast bat run on your map.

  Here's the options and explanations of what they do (and don't do). Most of the 
  selections will have a Tool Tip hint (pop up message if you hold the mouse over
  them) that gives a brief explanation of what they are. This section is organized just
  like the menu is in BspBuild.

     Menu Options : 
                     Bat Configs 
                       Load Configuration
                         Super Fast
                           1. Qbsp enabled
                           2. Qbsp -nofill enabled
                           3. Light enabled
                         Fast
                           1. Qbsp enabled
                           2. Light enabled
                           3. Vis enabled
                           4. Vis -fast enabled
                         Full
                           1. Qbsp enabled
                           2. Light enabled
                           3. Vis enabled
                         LeakTest
                           1. Qbsp enabled
                           2. Qbsp -nojunc enabled
                         No Vis
                           1. Qbsp enabled
                           2. Light enabled
                         Relight
                           1. Qbsp enabled
                           2. Qbsp -onlyents enabled
                           3. Light enabled
                         User Configurations
                           Here are 20 configurations that you may save into. You
                           can't load it if you haven't saved it yet. Once you have
                           a saved configuration, you may also rename the configuration.
                       Save Configuration
                         User Configurations
                           Select a slot to save your present settings and give it a
                           name. Name it something you will recognize, like SOA Full
                           (Configuration for running a Full compile on SOA maps)
                    New
                       Map
                         Select another map to compile.
                       Qbsp, Light, Vis, Quake
                         Select an alternative executable to run.
                    Options
                       Save Settings At Exit
                         Update the registry so the next time you start BspBuild
                         it uses the last options you had selected.
                       Quit BspBuild After Build
                         Runs the bat file then quits, or returns you to BspBuild.
                    Run
                       BspBuild.bat
                         Executes the created bat file.
                    View
                       All Bat Settings
                         Shows all of the settings for every program, as well as directories
                         and the utilities name.
                       Bat File
                         Views the bat file to be ran.
                    Help
                       BspBuild Help
                         Views this help file.
                       About BspBuild
                         Small about screen.
                    Exit
                       Quit BspBuild
    Everything else on the screen.

              Qbsp Command Line Options
                Run Qbsp
                  Disables or Enables Qbsp
                -notjunc
                -nofill
                -verbose
                  Qbsp spews out some of it's internal messages.
                -onlyents
                  Qbsp attempts to take an existing bsp file and reevaluates only
                  the entities. (Entities with attached brushes (doors) are not
                  applicable. Lights, players, monsters etc...are.
                Pause After Qbsp
                  Places a pause after Qbsp completes.
                Clear After Qbsp
                  Clears the screen after Qbsp completes.

              Light Command Line Options
                Run Light
                  Disables or Enables Light
                -extra
                  This preforms extra sampling on lights. A light is normally sampled
                  1 time. -extra does it 4 times. Takes 4 times as long also.
                -threads (1 to 4)
                -dist
                  Adjusts the distance light travels
                -range
                  Adjusts the area light graduates.
                Pause After Light
                  Places a pause after Light completes.
                Clear After Light
                  Clears the screen after Light completes.

              Vis Command Line Options
                Run Vis
                  Disables or Enables Vis
                -fast
                  Ultra fast vis. Degrading though. Useful for previewing your map.
                -v    
                  Vis spews out some internal messages.
                -level (0 to 4)
                  This performs extra vising. Reduces the stepping effect on shadows
                  and really reduces fps.
                -threads (1 to 4)
                Pause After Vis
                  Places a pause after Vis completes.
                Clear After Vis
                  Clears the screen after Vis completes.

              Quake Command Line Options
                Run Quake
                  Disables or Enables Quake
                Quake Type
                  Quake
                    Switches options to Regular Quake options.
                  WinQuake
                    Switches options to WinQuake options.
                -nocdaudio
                  Disable the CD from playing.
                -nosounds
                  Disables all sounds output.
                -nolan
                  Disables all networking code.
                -winmem (WinQuake is -heapsize)
                  Specifies how much memory to allocate from Windows (8 to 32)
                -winlock (Disabled for WinQuake)
                  Gets and locks down the memory it needs.
                -winlockunlock (Disabled for WinQuake)
                  Gets and then releases the memory it needs.
                -game
                  Drop down list of all the game directories off of Quake, 
                  that has a progs.dat or a pak file.
                +exec
                  Drop down list of all the config files off of Quake.
                Pause After Quake
                  Places a pause after Quake completes.
                Clear After Quake
                  Clears the screen after Quake completes.


              Bat Options
                Run As Previous
                  Runs the bat file in a window the same size as last time used.
                Run Maximized
                  Runs the bat full screen. Recommended. CPU resources goto compile.
                Run Minimized
                  Runs the bat as an icon in taskbar, CPU resources tied up in windows.
                No Echo
                  Disables the echo of the command line, but not the output of the execs.
                Echo Commands
                  Forces the display of every line of bat file. Messy.

	      Clean Options
                Del H Files
                  Deletes the temporary *.h1/*.h2 files Qbsp makes.
                Del Prt Files
                  Deletes the temporary *.prt file Qbsp makes.
                Del Pts File
                  Deletes the pts file in the working directory.
                Del Bsp File
                  Deletes the bsp file in the working directory.
                Del Quake Bsp Copy
                  Deletes the bsp file that was copied into the Quake directory.
                Del Quake Pts Copy
                  Deletes the pts file that was copied into the Quake directory.
                Copy Point File
                  Options to copy the pts (leak) file to Quake.

                Command Lines
                  These reflect all of the selected options you have chosen. It is
                  updated for every change made.

                The Hammer
                  Click it to launch the bat file BspBuild creates.

Version Release Information

[Version 0.12] 08/31/97 
  Removed a majority of the graphics and tuned BspBuild up for speed. All settings are on
    the main screen. Button Bar removed and a few menu options added. Sliders replaced with
    smaller-faster scrollbars. Timer function removed, I really do not have the time to create
    a database program.

[Version 0.11] 06/01/97 Maintenance Release
  Changed the command line for BspBuild so that it is compatible with the way BSP calls it.
    Previously it included the path. It is now just the name of the map file, without the
    .map extension. To use this option, you must put BspBuild in the BSP directory.
  Removed Qbsp -draw. Isn't used.
  Remove the Menu option to hide the command lines.
  Command lines and Current Programs are in 2 seperate folders.

[Version 0.10] 05/09/97 Public Release
  Really reworked the main screen. Options are back on main screen, just in folders
  for organization.
  A Real toolbar, and it's customizable.
  Added Qbsp -draw option.
  Added Light -dist and -range options.
  Added Quake -nojoy option.
  Added toggle for Quake / WinQuake options.
  Upped User configurations to 20 and they can be renamed.
  Placed Command Lines on main screen as well as Buttons to grab new exec's.
  Added toggle to the menu to hide / display command lines.
  Removed alot of unneccesary code. Much smoother operation now.
  Fixed bug that no one reported. Clicking 'X' to close only hid BspBuild.

[Version 0.09] 04/24/97 Public Release
 Main screen redone. All options on there own screen.
  Added ability to run any utility seperate from the bat file.
  Removed copy pause and clear options.
  Removed error checker, slowly implementing it into each program.
  Added View | All bat settings.
  Removed Alternate from menu, replaced with button on each programs screen.

[Version 0.08] 04/20/97 Private Release
 I disabled the following:
       1. Drop down map list. 
       2. MapInfo. (Another time, another program ;})
  I Added the following:
       1. 6 configurations to save and load to.
       2. Alternative utilities. Just find the exec.
       3. Del Quake Pts.
       4. Load defaults. 
       5. Sliders to control all number values.
       6. Status bar. Shows brief description of action, and Time.
  I changed the following:
       1. Revamped the Time Button. (seconds now)
       2. BspBuld using Windows Registry. No ini file.
       3. Improved command line. Checks for errors.
       4. Fixed up the bat file code.
       5. Fixed the file copying routines.
       6. BspBuild checks for correct drives.
       7. Checks to see if the map directory and quake\id1\maps directory is same.
       8. Titlebar shows path and maps name.
       9. Added search for pak addons to the game list. (hipnotic,etc...)
          
[Version 0.07] 04/13/97 Private Release
  Major Bug Squished (yuck). It seems removing items from a list,
                 changes the index to all proceeding items. Ouch!
  Added Button Bar.
  Enabled shortcut keys to all menu items.
  Added Quake +exec for the optional config files startup.
  Added Clear Screen Options.
  Added Run Bat Options.
  Added Misc Options.
  Added my own Notepad with searching capabilities.

[Version 0.06] 04/12/97 Private Release
  Major rewrite. 
  Uses an ini file instead of registry. 
  Added Map Info.
  Various bat operations fixed.
  FileCopy bug fixed.

[Version 0.05] 04/08/97 Private Release
 Bugged Version
  Scrollbars removed. Dropdown list instead.

[Version 0.04] 04/08/97 Private Release
 Removed the command line displays. Seemed to redundant when you see the switch
     and speed up the code dramatically. Can still see them by viewing the bat file.
  Added -game Quake command and added dropdown list of all directories containing
     the necessary progs.dat file.

[Version 0.03] 04/01/97 Private Release
 Fixed all of the file not founds in the bat file operations.
  Fixed opening of the help file, bat file, and the error checker file.
  Major screen relayout. ( a little better steve? )
  Relocated the command lines to each appropriate options box. Neater look, I think.

[Version 0.02] ??/??/?? Private Release
 Minor changes to the program. Removed the bogus options, organized the option
  folder a bit. Added trouble shooting code to the errorchecker. About box.

[Version 0.01] ??/??/?? Not released




