

                     ******* VGB Launcher *******
            The Portable Nintendo GameBoy Emulator Launcher
                         version 0.6.2 (DOS)

              by Steve Abson (sabson@chat.carleton.ca)
                         
                             Thanks to:
             Marat Fayzullin (for the original VGB)
             Marcel de Kogel (for the DOS port of VGB)
             Jeff Frohwein   (for the sound code & title of VGB)

             Latest version of VGBL always available at:
              http://chat.carleton.ca/~sabson/vgbl.html

         (*) GameBoy is a registered trademark of Nintendo.
         (*) Game Genie is a trademark of Lewis Galoob Toys, Inc.
         (*) All other unspecified properties are recognized as
             belonging to their respective owner(s).

This file contains notes about features specific for VGBL 0.6.2

NEW FEATURES in this version
============================
.DAT and .CFG files cleaned up.  Added window colours and brightness.  Now
uses VGB's -background option instead of swapping GIF files itself.  Help
screens updated to reflect changes.  VGBL specific DEFAULT colour added.

Hardware Requirements
=====================
Same as for VGB-DOS 0.6.2
Mouse (optional)

Files included in VGBL.ZIP
==============================
VGBL.EXE      The VGB-DOS 0.6.2 launcher
VGBL.TXT      The VGBL documentation
VGBINV.EXE    The VGB Inventory Maker v1.0 program
NINTENDO.GIF  An example game GIF (used with Super Mario Land)
MARIO.DAT     An example config file for Super Mario Land
MARIO.DIZ     An example description file for Super Mario Land
FILE_ID.DIZ   File description for use with BBSs.

Key Mapping
===========

Main Menu
---------
Left Arrow  - Move left in file window
Right Arrow - Move right in file window
Up Arrow    - Move up in file window
Down Arrow  - Move down in file window
D           - Reset all values to default
C           - Edit selected color setting
L           - Edit volume setting
R           - Edit CRC setting
E           - Edit delay setting
W           - Edit swap setting
F           - Edit ifreq setting
I           - Edit video setting
S           - Edit sound setting
U           - Edit uperiod setting
V           - Edit vperiod setting
B           - Edit bright settings
H           - Edit scheme settings
T           - Edit stereo setting
F1          - Display help screen
F2          - Display example color screen
CR (ENTER)  - Loads submenu for game specified
X (or ESC)  - Exits VGBL

SubMenu
-------
S           - Saves configuration of game
E           - Edits description of game
G           - Edits GIF name for game title
X (or ESC)  - Exits the submenu
CR (ENTER)  - Loads Game Genie menu for game specified

Game Genie Menu
---------------
0-9         - Activates corresponding Game Genie code
E           - Edits selected Game Genie code
X (or ESC)  - Exits Game Genie menu
CR (ENTER)  - Runs VGB with the game, config, and codes specified

Configuration files
===================
The VGBL.CFG file is the main data file that VGBL relies on.  The only part
of it that I recommend you edit are the first two lines.  The rest of the
file is setup in a specific way to hold game descriptions and Game Genie
codes.  If you meander down to that part of the file and edit something
incorrectly, your descriptions and/or GG codes could be lost.

The first line of VGBL.CFG is the name of the VGB-DOS executable file (default
is "VGB-DOS.EXE").  If you rename your vgb-dos executable, or compile a version
of your own, this is where you tell VGBL what to use to play games.  The
second line of VGBL.CFG is your cart image path.  This tells VGBL where to
look to find cart images.  By default, it is set to ".\" which is the current
directory.  If you have problems running VGB-DOS through VGBL, these are the
first two lines you should take a look at.

If you have problems that editing the first two lines won't fix, try backing
up your VGBL.CFG file and deleting the original.  If things work again, then
you know where your problem lies.

VGBL no longer modifies the VGB config file (usually VGB-DOS.CFG), but uses 
it's contents for the default configuration (if the file exists).  When you 
run a game, the settings shown in VGBL are used but the original VGB config 
file is restored once the game is done.

Individual Cart Configuration
=============================
If you have a specific .CFG file for a ROM image you are loading, those
values will over ride the values you specify in VGBL.  It is recommended
that you rename these files so that they have a .DAT extension.  That way
VGBL will recognize them and load their defaults when that game is specified
You are still able to modify the values and have them work in VGB if you use
the .DAT extension rather than .CFG.  Again, there is no difference between
the game's .CFG and .DAT file, other than extension.

When you save a game's configuration under the SubMenu, the configuration is
written to a .DAT file, ensuring that you maintain control over VGB's
variables.

See the enclosed MARIO.DAT file for an example.

Game Descriptions & GIF Files
=============================
The submenu (accessed by pressing [ENTER] when a cart image is highlighted)
is where descriptions and the GIF file setting can be found in VGBL.  If you
have not given an image a description, then the filename of the image will
be displayed on the first description line.  When you save the description,
it's contents are stored in memory until you exit VGBL, at which point they
will be written to the VGBL.CFG file to be retrieved for next time.  It is
important that you fully exit VGBL to make sure that your description (and
Game Genie codes, for that matter) are saved to disk.

The GIF file used to be swapped internally by VGBL.  As of VGBL v0.6.2 the
GIF file is handled as a parameter for VGB-DOS (using the new -background
feature).  That means that GIF file names are no longer stored with the
game's description, but in it's .DAT file.  To make sure the GIF file is
saved, you now have to save the game's config from the submenu.

If you still have an old .DIZ file for a cart image, and no description is
yet entered for it, VGBL will use the contents of the .DIZ file for the
cart's description.  Once the description has been read, the old .DIZ format
file is deleted.  The description is now in memory, and will be saved to
the VGBL.CFG file when you exit VGBL.

See the enclosed MARIO.DIZ file for an example.  When you run VGBL, if you
don't have a description for Super Mario Land, this file is loaded and then
deleted.  It's contents will be stored in VGBL.CFG when you exit VGBL.

VGB Inventory Maker
===================
The VGB Inventory Maker is a simple program which creates a user 
specified file with information on all *.GB files in the current directory.
It's a quick and easy way to keep track of your image files.

Parameter Passing
=================
As of VGBL v0.6.1a you can set parameters on the command line for VGBL.
These parameters will in turn be passed to VGB-DOS everytime a game is run.
For example, if you load VGBL by typing "VGBL -cheat 123-456-789", then
every time you run a game, the "-cheat 123-456-789" parameter is passed
to VGB-DOS.  This is a way to pass parameters not supported by VGBL (because
they are seldom used, or really don't affect gameplay).

If you try to pass a parameter that is unfamiliar to VGB-DOS, then when you
try to play a game within VGBL the screen will flash and you will be returned
to VGBL immediately.  For a list of all valid parameters, type "VGB-DOS -help"
at the DOS command prompt.

Game Genie Codes
================
VGBL v0.6.1b introduces in program Game Genie code support.  Now, instead of
VGB-DOS running when you press <ENTER> in the submenu, the Game Genie menu
comes up instead.  There you can activate which codes you want to use, or
edit which ever slot you want.  While you remain in VGBL, the codes you
activate will remain activated (in case you want to modify some variables,
then launch the game with the same activated codes).  When you exit and load
up VGBL again, you will have to reactivate your desired codes.

If you try to use an invalid code (either one that is not XXX-XXX-XXX format
or, while containing the correct values, does not do anything) then when you
try to run your game the screen will flash and you will return to VGBL.  Make
sure that the code you are attempting to use is indeed valid.  If you got it
from a magazine, or a Code Masters update, then you should have no problems.

Troubleshooting
===============
If you have problems with VGBL, check the sections above for some suggested 
solutions.  Also, if when you press return the screen flashes but does not 
launch VGB, check if the ROM image is valid.  You can do this by typing 
"vgb-dos tetris.gb" at the DOS prompt (substituting the name of your 
executable and game in question).  This will show you if VGB is having 
trouble loading the file.  If the ROM image is indeed invalid try correcting 
the CRC checksum with one of the many available tools.  I recommend Masters
of Magic's GB Tool, which can be found on the VGBL homepage (listed at top).

Disclaimer
==========
This program is designed around the functions and abilities of VGB-DOS
v0.6.2 (ported by Marcel de Kogel).  It may or may not work with earlier
versions of VGB for DOS (most likely it will let you pick your game, but
the other specifications will be ignored).  It may or may not work for
future versions of VGB for DOS.  There are no guarantees of compatibility.
Use VGB-DOS 0.6.2 for best results.

History
=======
v0.5.1  (04/09/96)  - First version released to internet.
v0.5.10 (04/11/96)  - Fixed some file display bugs, removed extra keypress
                      to start VGB, added working slide bar and individual
                      game GIF files.
v0.5.11 (04/15/96)  - Little bugs fixed, submenu added allowing access to
                      game description, independant GIF file, and game config
                      saving (to .DAT file).  Description and GIF file name
                      saved to (.DIZ file).
v0.5.11b (04/20/96) - Fixed bug so that VGBL works with all DOS v3.0+ instead
                      of just DOS v6.0+, minor cosmetic changes.
v0.6.1 (05/05/96)   - Added mouse support, more variables, help screen,
                      example color screen, and included VGBINV program.
v0.6.1a (05/22/96)  - Improved mouse support, VGBL.CFG file replaces .DIZ
                      files, parameter passing at command line.  Replaced
                      Sailor Moon examples with Super Mario Land examples.
v0.6.1A (05/23/96)  - Quick version released which fixed buffer bug.
v0.6.1b (05/26/96)  - Buffer bug totally fixed, added in program Game Genie
                      code support.  Minor program optimizations.
v0.6.2 (06/04/96)   - Added variables new to VGB-DOS v0.6.2, optimized .DAT
                      and .CFG files.  Updated main menu and help screens.
                      Now uses -background parameter for GIF passing.  All
                      functions now internal (except lauching VGB of course).

Credits
=======
This program was made by Steve Abson (sabson@chat.carleton.ca).
Thanks to Marat Fayzullin (fms@wam.umd.edu), Marcel de Kogel 
(m.dekogel@student.utwente.nl) and Jeff Frohwein (jfrohwei@hiwaay.net) for 
the reasons mentioned above.

Please check out GrooveyDom at http://chat.carleton.ca/~sabson and
let me know what you think.
