
-----------------------------------------------
GBXM - Nintendo GB/GBC Emulator - Readme
-----------------------------------------------

Programmed by : Olivier SANGALA
Version : 0.1
License : Free under GNU General Public License ( see "gpl.txt" )
Release Date : 06/01/2007
Platform : Windows 9x/Me/XP
Website : http://olivier.sangala.free.fr
Email : olivier_sangala@hotmail.com


----------
License
----------

    Copyright (C) 2004-2007 Olivier SANGALA

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

---------
Legacy
---------

You must not use this program to run non free domain roms,
unless their respective authors has given you an authorization.
The author has no responsibility concerning such a use.

-----------
Description
-----------

GBXM is a Nintendo GB/GBC emulator for Windows.
This software supports most gameboy cartridges.

---------------
Specifications
--------------

This software requires DirectX 9 or higher.

You can download DirectX from :
http://www.microsoft.com/windows/directx/

Color Requirement : 16 or 32 bits display

Drag/Drop File supported

Default Joypad Keys :

Right : RIGHT
Left : LEFT
Up : UP
Down : DOWN
Button A : W
Button B : X
Select : BACKSPACE
Start : RETURN

"Stretch Texture Filter" option may not work if
your video card does not run the choosed filter.


---------
SUPPORTED
---------

System : GB/GBC
Cartridge : GB/GBC Games
Memory Bank Controllers : ROM ONLY,MBC1,MBC2,MBC3,MBC5

-------------
NOT SUPPORTED
-------------

Cartridge : Remaining MBC types
Cartridge : Real Time Clock (RTC)
SGB Functions
InfraRed port
infrared LED input / output
Serial I/O Ports


*** Speed restriction is NOT SUPPORTED YET.
*** Sound emulation is nearly completed ( synchronisation, envelope, channel4 to be completed)
*** CGB screen emulation is nearly completed (some problems with real time palette changes)

-------------
Menu Commands
-------------


States
------

You can open or save state files, that include the current state of emulation system.
This must be done while rom is opened.

Reset
-----

"Reset" and "Hard Reset" commands both reset the system
BUT "Hard Reset" also clears ALL RAM MEMORY

Debug
-----

"Debug..." command displays information concerning gameboy state.
There are 3 boxes : one for memory, one for code, and one for registers.
You can press some keys for some boxes to have interaction :


Keys for Memory Box :

Up : line up
Down : line down
Page up : page up
Page down : page down
'G' : goto adress

Keys for Code Box :

Up : line up
Down : line down
Page up : page up
Page down : page down
'G' : goto adress

Options
-------

You can change options concerning system, display, sound and inputs using the "Options..." command.

"Window Color" is the color that is displayed in main window around gameboy screen.
This color is not visible when "Screen Size" option is set to "Window Size".


Options that may influence emulation performance :

- Thread Priority
- Speed restriction
- Frame Refresh Rate
- Screen Layers

Options are automatically loaded from/saved to file "GBXM.INI" when application is opened/closed.


--------
Resource
--------

The source is compiled with Borland C++ Builder 5.

DirectX9 librairies are from : "CBuilder_DX92_libs"
Download link : http://clootie.narod.ru/delphi/DX92/CBuilder_DX92_libs.zip

This source includes a modified Z80 emulator :
Z80: portable Z80 emulator
Copyright (C) Marat Fayzullin 1994-2002


--------
History
--------

Version 0.1 : Initial release (06/01/2007)

