Date: January 3, 1999
Q2 BeaVeR
Version: 4.0.0 (beta)
Copyright (c) 1998 MERZone Software
All rights reserved

BETA RELEASE
------------
This is a beta release of Q2 BeaVeR. That means 
that it hasn't been fully tested on all systems. 
If you want to try this utility out please let 
me know of any bugs found, enhancements required, 
etc. so we can make this utility all that it can 
be! Please send feedback to Q2BeaVeR@merzone.com.

OVERVIEW
--------
Q2 BeaVer is a Windows interface that frontends the
compiling utilities used to compile Quake 2 and
Half-Life  maps. This works with the files provided 
by id for Quake 2 (QBSP3.EXE, QVIS3.EXE and QRAD3.EXE) 
as well as the ones provided by Valve for Half-Life
(QCSG.EXE, QBSP2.EXE, VIS.EXE and QRAD.EXE). But it 
can also work with other third-party compiling 
utilities. This program makes it easy to select which 
options you want to use to compile your maps and then 
with the press of a button it will run your selected 
compile utilities with the appropriate command line 
parameters.

By the way...Q2 BeaVeR stands for Quake2 frontend 
for BSP, VIS and RAD. A little outdated now that
it now supports Half-Life that introduces another
compiler (CSG), but I didn't want to change the name.

For the latest release of this program and other 
useful Quake2 map editing resources come visit
my website (The MERZone) at http://www.merzone.com.

CHANGES
-------
Version 4.0.0
    1) Added Half-Life support. To activate it, 
       simply select Half-Life from the new
       Game menu. Because of the way things
       were changed in the registry, any settings
       from a prior install of Q2 BeaVeR will be
       lost. All compiler paths, etc. will need
       to be re-setup.
    2) Added new MapSpy tab to the Quake2
       side. Along with it getting its own tab,
       I added support for a few new options
       that have been added to MapSpy since
       the last release.

Version 3.0.0
    1) Added checkbox to allow turning off the -level
       (Test Level) parameter for the VIS program. 
       This is because the -level parameter doesn't
       do anything in Quake 2 compiling. It is just 
       a carry over from Quake 1 days.
    2) Added tab for ArghRad options. To active, select
       ArghRad as the RAD program on the RAD tab.
    3) Now uses Windows Notepad to display readme file
       and batch file instead of built in text viewer.
       This was done to spead up viewing as well as
       to make Q2 BeaVeR a bit smaller.

Version 2.2.0 (never released)
    1) Fixed bug that added a zero to current MAP
       name when selecting the tenth MAP file 
       from the list of most recent MAPs on the
       File menu.
    2) Added support to call MapDCap by David 
       Hill. This utility takes the .MAP file 
       and converts it to all lower-case text.
       This was done bacause the Shareware version
       of WorldCraft saves the MAP files in all
       upper-case which chokes the Quake2 compilers.
       This utility is called if the new
       option is checked on the General Options
       tab to convert the MAP to all lower-case.
    3) Added support to call MapSpy by Tony Ferrara 
       and David Hyde. This utility will display
       a lot of information regarding the current
       MAP file. There are now several options for 
       this utility on the General Options tab. To
       run this utility, simply Click on the new
       "Run MapSpy" button.
    4) Added field to specify final .BSP directory
       on the Paths form. This is useful if you want
       to save your final compiled BSP file to a 
       different directory. This is mostly only 
       needed if your making a MAP for a MOD.

Version 2.1.1
    1) Fixed bug that could cause "File not found"
       message during compile attemp.

Version 2.1.0
    1) Made it so the "Find latest map" button
       updates the list of recent maps on the
       File menu.
    2) Fixed bug which could lock up Q2 BeaVeR
       when using new timing feature.

Version 2.0.0
    1) Should now work better with Windows NT 
       machines.
    2) Added General tab which contains those
       options that were on the main form under
       the buttons and some additonal features.
    3) When selecting to delete temporary files
       Q2 BeaVeR will now also delete the .lin 
       file. This is the file that contains leak
       information.
    4) Increased the number of most recently
       compiled maps on the File menu from 5
       to 10. I find I work on a lot of maps
       at the same time and 5 just wasn't
       enough for me :-)

Version 1.0.0
    1) Added command line support for MAP file
       names.
    2) Moved the "Start in DM Mode" option box to
       the new "Quake 2 Options" tab.
    3) Added a new Quake 2 Options tab. 
    4) When selecting a new MAP from the menu it
       will start out in the directory where the
       last MAP was loaded from. This should save
       a bit of time since you don't have to find
       the directory each time.
    5) When selecting the compiling utilties the
       dialog that comes up will indicate which
       utility you are searching for within the
       window's title area. Also, if a utility
       had previously been selected you will start
       out in that directory.
    6) Added "Save Current Window Position" to the
       Options menu. When selected, this will save
       the position of the Q2 BeaVeR window and then
       the next time it is loaded it will redisplay
       in the same spot.
    7) Added option ("Pause at each step") that 
       when checked will cause a pause after each
       compiler has finished. This allows you to
       view the results of the compile before the
       next one starts. The compiling wil pause
       until you press a key on the keyboard so
       if you plan on just letting the compilers 
       run with you away from the computer you won't 
       want to check this or else you could come 
       back days later and only BSP has run..DOH! :-)

Version 0.1.1
    1) Changed name from BVR/Q2 to Q2 BeaVeR. 
       I thought it was a little catchier :-)

FEATURES
--------
Since 4.0.0
    1) Added support for Half-Life.
    2) Added support for latest options added
       to MapSpy.

Since 3.0.0
    1) Now has direct support for ArghRad options.

Since 2.2.0 (never released)
    1) Can now convert MAP files to all lower-case.
       Apparently the shareware version of WorldCraft 
       saves the MAP files in upper-case which the
       Q2 compilers don't like.
    2) MapSpy is fully integrated.
    3) Can now save the final .BSP file in a user
       specified directory. Great for MOD makers.

Since 2.0.0
    1) Added feature that allows you to display
       the actual time it took to run each compile
       step. This option is found on the new General
       Options tab. I'm using a third-party utility
       to give this functionality and apparently it
       is only good up to 10 days. I haven't been
       able to test that since none of my maps take
       more than a few hours to compile. If anybody
       runs one of the compilers for more than 10
       days with this option turned on, please e-mail
       me at q2beaver@merzone.com and let me know 
       what happens :-)
    2) Added button labeled "Find latest map". It is
       down to the right of the "Map to compile" box
       at the bottom of the Q2 BeaVeR form. This 
       feature will scan the directory where the last
       map was selected from and find the .map file
       with the latest date/time. So, if you just
       created a new .map file you don't have to
       search for it you can just click this button
       and it'll find it quickly for you and setup
       Q2 BeaVeR to compile that map file.
    3) Added option on the new General Options tab
       to allow you to tell it to pause between
       each compile step (BSP, VIS and RAD). If 
       turned on, after each compiler program is
       run it will display a message and wait for
       you to press a key before it goes on to the
       next step. This is useful if you want to see
       the output of each step before it scrolls off
       the screen. But, it has got me before where 
       I had this turned on and didn't realize it 
       when I walked away to let it compile. I came
       back hours later only to find it only did the
       BSP and was just sitting there waiting for 
       somebody to press a key...doh!
    4) Added option to pause the DOS screen after all
       the compilers have been run. 

Since 1.0.0
    1) You can now specify the name of the MAP file
       through the command line. To do this, just
       add the path/name of the MAP file immediately
       after the call to Q2BeaVeR.

       Example:
           Q2BeaVeR.EXE C:\MyMaps\Base1.MAP

    2) New Quake 2 Options tab to allow you to 
       select certain options that will be set when 
       Quake 2 is launched from within Q2 BeaVeR.

       Quick rundown:
           - Launch in Deathmatch Mode
                 This will cause Q2 to launch in
                 DM mode. This was included 
                 originally because I didn't like
                 having to have the Q2 CD in the
                 drive whenever I wanted to test my
                 MAP and in DM mode the CD wasn't
                 required. But now, since id released
                 patch 3.15 the CD is no longer 
                 required in ANY mode. But I'm going
                 to leave this option here anyway.
           - Launch in Software Mode
                 Causes Q2 to launch in software 
                 mode. I added this because I have
                 problems if I run Glide Qoole and
                 try to run Q2 in 3dfx mode.
           - Allow Cheats
                 This will turn on cheats so that
                 you can use the cheat codes when
                 testing your level. This, of course,
                 is only useful if you launch in DM
                 mode. The cheats I most often use
                 when testing are GOD, NOCLIP and
                 GIVEALL.
           - WAV Only
                 This turns on some type of sound
                 option when launching Q2. I'm not
                 sure exactly what it does but on
                 one of my machines I must use this
                 option or else the sound is bad.
           - CD-ROM Drive
                 Let's you specify the drive letter
                 of your CD-ROM. 
           - Launch in Window
                 Forces Q2 in launch in a Window.
                 NOTICE: I found out that if you
                 try to launch in a Window when the
                 mode Q2 is in doesn't support it
                 the Q2 screen never shows up! This
                 caused me some frustration until I
                 realized what was going on. If this
                 happens to you, to fix it, close
                 Q2 if it is still running then
                 check "Launch Full Screen" and 
                 launch Q2 again from withing Q2 
                 BeaVeR.
           - Launch Full Screen
                 This will cause Q2 to launch in
                 Full Screen mode.

Since 0.1.0
    1) It's free!

    2) Frontends all three of the compiling utitlies 
       used to compile Quake2 .MAP files. This 
       program will work with the original id utilities 
       or third-party utilities.

    3) Easy to use graphical user interface.

    4) Each option has tooltip help that gives 
       explanation of what that particular option does. 
       To see this help, pause the mouse pointer over 
       the option.

    5) Allows you to launch Quake 2 in either normal 
       mode or Deathmatch mode with all the parameters 
       necessary to load the map just compiled.

    6) Has customizable "quick setup" buttons. These can
       be customized so that when you click them they 
       change all the settings to your predefined 
       selections. There is a button for "Quick Compile" 
       (good for testing), "Default Compile", and
       "Final Compile".

    7) Has free form "additional parameter" fields for
       each compiler program. These allow you to enter 
       additional parameters that new third-party 
       compilers may offer which weren't offered in the 
       original id compilers.

    8) Lists the last five maps that you compiled on the
       File menu for quick access to them again.

    9) Allows you to select whatever programs you want 
       to use to BSP, VIS, and RAD you maps.

   10) The three checkboxes across the top of the screen
       allow you to select which compiling utilities you 
       want to run on your MAP when you press the Start
       Compiling button. 

QUICK SETUPS
------------
One of the features of Q2 BeaVeR is it's Quick Setup 
feature. There are three buttons available which
can be customized. These buttons (Quick compile,
Default compile, and Final compile) will instantly
set all the options for BSP, VIS and RAD. These
come with preset values but may be customized. To
customize them, first go through all the BSP, VIS
and RAD options and set it up how you want it. Then
go to the Options menu and select Quick Setups. 
Another menu will be displayed. Now, select the 
"Save Current Options As..." item to save the current
settings as the selected Quick Setup. If you ever
want to restore the original Quick Setups, just 
select "Restore Original Quick Setups" from that
same menu. 

The "Quick Compile" setup was meant to be used when
you want to quickly test some change you made to you
MAP and don't need to check the details.

The "Default Compile" setup was meant to be setup 
with your most common compiling options.

The "Final Compile" setup was meant to be used to
set the options for optimum quality for your final
compile before you release your MAP. You'll probably
want to compile your maps this way once in a while
throughout your design process to make sure it is
looking the way you expect.

INSTALLATION
------------
The directory where you unzipped Q2 BeaVeR contains all 
the necessary files to setup the program. Q2 BeaVeR is 
a 32-bit Windows program and thus requires either 
Windows 95/98 or Windows NT to run. To start setup, 
run the SETUP.EXE program from the directory where 
you unzipped Q2 BeaVeR into.

UNINSTALLING
------------
Q2 BeaVeR can be uninstalled from your system by going to 
the Windows Control Panel, select Add/Remove Programs, 
and select Q2 BeaVeR to uninstall it.

DOCUMENTATION
-------------
At this time, this README.TXT file is the only written
documentation. I feel the interface is pretty 
self-explanatory. Don't forget, to get information
regarding what each option does, just hold the mouse
pointer over the option for a second or so and a tip
will be displayed giving you an indication of what that
option does.

REGISTRATION
------------
Q2 BeaVeR is released as freeware. This means you are 
free to use this copy of Q2 BeaVeR as much as you want 
for free. You are free to make copies of the original 
unaltered distribution ZIP archive to give to anybody 
you wish. Any such distributions must be done for free. 
Freeware is still copyrighted and thus you cannot make 
any changes to this program.

CONACT INFORMATION
------------------
I would greatly appreciate any feedback regarding 
Q2 BeaVeR. This includes comments, questions, bug 
reports as well as feature requests that you'd like to 
see in future versions. Please e-mail commments to 
Q2BeaVeR@merzone.com. You can also find the latest release
of this program and other useful Quake 2 map editing
resources at http://www.merzone.com.

Enjoy,

Mark Reddick
shadow@merzone.com