*************************************************************
* GBE - GameBoy Emulator v0.30                              *
* by Jim Geffre (jgeffre@nd.edu)            06/15/98        *
* http://www.nd.edu/~jgeffre/gbe.html  (homepage)           *
* http://www.nd.edu/~jgeffre/wip.html (work-in-progress)    *
*************************************************************

1. Introduction
2. Updates to this version
3. Usage
4. Current Status
5. Future
6. Known Bugs and Limitations
7. Acknowledgements
8. Disclaimers

--------------
1. Introducion
--------------
   GBE is a DOS-based emulator for the Nintendo Gameboy
written entirely in 386 assembly language, utilizing 
Adam Seychell's DOS32 protected mode extender.  It
is freeware, but is not to be distributed with any ROMs.

----------
2. Updates
----------

0.30    -Major rework of CPU flag emulation.  This fixed Final Fantasy 
	 Adventure, Darkwing Duck, Kid Niki, F1-Race, and others.  Thanks
	 go to Matt Currie.
	-Partial Super Gameboy support.  Thanks to Marat Fayzullin, Jeff 
	 Frohwein, Anders Granlund, and k00pa, I was able to add support 
	 for Super Gameboy borders.  Improved SGB emulation will follow
	 shortly.
	-Added an integrated debugger. (Paul Robson)
	-Added two new video modes, both 256*256*256, one with scanlines.
	-Various bug fixes (Fortress of Fear, Daedalian Opus, Zoop, Alfred
	 Chicken, and several others)
	-Added correct CPU cycle counts.
	-External saves for various configuration flags 
	-Improved LCD emulation (sprite on/off bit, Taz Mania.  Thanks to
 	 Anders Granlund for reporting this.)
	-Two screenshot sizes to accomodate SGB and non-SGB compatible
	 games.
	-Fileloader now allows for directory changes
0.21:	-Fixed a bug in bankswitching scheme (Donkey Kong Land III).
	 This was causing graphical and musical bugs in several other
	 games. 
	-Rewrote Gameboy interrupt handling 
	-Rewrote display timing code
	-Fixed code for the Gameboy's internal timer (Mario Land)
	-Fixed swap opcode emulation (Wario Land II).  I forgot to add
         code to affect the flag register.  
	-Cleaned up sound code
0.20:	-First release

--------
3. Usage
--------
Type gbe.exe or gbe.exe filename.gb.  Using the latter will
automatically load the given file, otherwise a file load screen
will pop up.  Use the mouse to select a file and change current
directory.

GB Control
------------
Joypad - Arrow Keys
B      - Ctrl
A      - Alt
Start  - Enter
Select - Tab

GBE Control Options
------------------------
F1  - Pop up a short help screen
F4  - Save screenshot in .pcx format (Saves as file.pcx)
F5  - Load a real-time save file from slot 0-9.  Pressing enter aborts.
F8  - Save a real-time save file in slot 0-9.  Pressing enter aborts.
S   - Enable\Disable Super Gameboy support (default - enabled)
V   - Toggle Video Mode.  There are two possible video modes, both
      are 256*256*256, however one includes the "scanlines" effect.
      Scanlines are turned off as default.  
      *Note* The scanlines mode may cause problems on some video cards.
J   - Disable joypad.  Pressing a joypad button during emulation will
      enable the joypad.
Esc - Exit emulation and return to file load screen
Backspace  - Reset emulation

Debugger Control Options
------------------------
I decided to use modified code from Paul Robson's GB97 in order to add an
integrated debugger.  This is a temporary solution, and I take no credit 
for this code.

F12   - Enter debug screen
F1-F4 - Set a breakpoint
F5    - Run to a breakpoint
F7    - Single step
F8    - Single step and skip subroutines
F10   - Return to game and ignore breakpoints
Home  - Move code cursor to the program counter
End   - Move data cursor to $FF00h

To move the code cursor, use the arrows to skip 8 bytes and page
up or down to skip 64 bytes.  To move the data cursor, hold control while
pressing one of the above four keys.  To directly skip to an address, type
it in with the keyboard.

Super Gameboy issues
----------------------
Currently, Super Gameboy emulation only includes support for the borders 
built into certain games.  I will add shortly emulation of the palettes 
which affect the main action window, however it is not included in this release.

Having Super Gameboy emulation turned on may cause a SGB-compatible game to
run incorrectly or to not run at all.  If this happens, I suggest disabling
Super Gameboy emulation and then restarting the game.  This will most
likely allow the game to run properly.

-----------------
4. Current Status
-----------------
Basic GB emulation
Partial Super Gameboy support (borders only)
Adlib sound support
Joypad support
Ten slots of real-time saves
Screenshot saving in .pcx format
File Loader
Integrated Debugger	

---------
5. Future
---------
Improve sound emulation
Improve Super Gameboy support
Game Genie cheats
Fix various bugs
I suspect 2-button joypads may have improper key settings

-----------------------------
6. Known Bugs and Limitations
-----------------------------
* Any other games that do not work.  I have neither the time nor resources to
  test 1000 GB roms, so I would appreciate bug reports in this area.  Any
  constructive comments, criticisms, or suggestions are welcomed.

-------------------
7. Acknowledgements
-------------------
I would like to thank the following people.  I truly appreciate
all the help and documentation I have received.  This list is by
no means complete.
	Paul Robson			Julien Frelat
	Ben Haynor			lilac
	Jeff Frohwein			Clayton Fairs
	Marat Fayzullin			^Xer0
	Pan of Anthrox			Anders Granlund
	k00pa				Matt Currie
	
	
--------------
9. Disclaimers
--------------
GBE Copyright 1998 Jim Geffre
I accept no responsibility for the fitness of this software.
Gameboy and Super Gameboy are registered trademarks of Nintendo Co., Ltd.
I am not affiliated with Nintendo, nor do I condone the piracy
   of GB ROMs.
GBE may not be sold or distributed with ROMs.

Thanks,
Jim Geffre
jgeffre@nd.edu