,`,,`,,`,,`,,`,,`,,`,,
 
                                   GnuboyGX 1.4   
 
,`,,`,,`,,`,,`,,`,,`,,
 

-=[ INTRODUCTION ]=-
 
GnuboyGX is a port for the Nintendo Gamecube and Nintendo Wii (running in GC mode)
of the open-source Gnuboy emulator, originally coded by Laguna and Gilgamesh.
More infos about Gnuboy here: http://en.wikipedia.org/wiki/Gnuboy

This port is based on the last 1.0.4 CVS source, released by Joshua_ from EFNet #gameboy
http://www.netaxs.com/~gevaryah/gnuboy-1.0.4pre.tar.bz2.

This has nothing to do with the previous GX port for GCLinux, this is a full standalone
port using LibOGC API (GX, Audio, Inputs...)

If you have any questions about this, please contact us on the official GnuboyGX thread:
http://www.tehskeen.com/forums/showthread.php?t=4443



-=[ CHANGELOG ]=-
23/04/2007:
 . corrected a little bug with SRAM/STATE saving
 . modified key config upon request: SELECT is now assignated to Y Button

17/04/2007: 
 . added SRAM, RTC & STATE load/save support
 . added GUI and configurable options menu
 . corrected Sound Samples conversion (thanks to Softdev)
 . changed Sound Buffering Technic(changed to "head/tail" technic used by Softdev in NeoCDredux)

13/04/2007: WIP1
 . initial release



-=[ FEATURES ]=-

 .Gameboy and Gameboy Color emulation with sound
 .DVD & SDCARD support for rom loading
 .Savestate load/save on Memory Card 
 .SRAM & RTC load/save on Memory Card 
 .support for 8MB roms
 .support for zipped roms



-=[ WHAT'S MISSING ]=-

 .Mono Gameboy palette user configuration
 .RTC Synchro: Here's a note about RTC, taken from original gnuboy's documentation: 
	  "Some roms, notably Pokemon ones and Harvest Moon, use a realtime clock to keep
	  track of the time of day even when they're not running. Since gnuboy is just an
	  emulator, it can't work like a real cartridge and make things like this keep
	  happening while the emulator is not running. However, it can resync the Gameboy
	  realtime clock based on your computer's clock when it starts. This is what the
	  "syncrtc" option does. By default it's  enabled. If you disable it, then no time
	  will seem to have elapsed between when you exit the emulator once and when you
	  start it again the next time."



-=[ REQUIREMENTS ]=- 

* SoftMod and/or HardMod (to boot the dol)
* Zipped or not (.gb & .gbc) ROMS



=[ MENU ]=-

Play Game : Run the game you just loaded or return to game
Game Info : Some informations about the ROM
Reset Game: Reset emulator

Load New Game:
  . Load from DVD: DVD must be ISO9660
  . Load from SDCARD: Roms must be placed in a directory named GBROMS
  The maximum number of files per directory is 1000. You can use subdirectories.

Emulator Options:
  . Scale X, Y: Let you modify the size of the display screen
  . Filtering: Gnuboy can filter screen colors to make them look more washed out or faded
    like on a real GBC. You can also allow this for Mono GB games by setting the value to "ALL"
  . Sprite Sorting: Enable/Disable sprites to be sorted and prioritized according to their x
    coordinate when in DMG (Mono GB) mode.
  . Force Mono : For GBC games to run in Mono GB mode.
  . GBA Features: Unlock gba-only features in some cgb games (See Zelda Oracle's serie)
  . SRAM AutoSave/Autoload: this is actullay disactivated

Memory Card Manager:
  . SRAM Manager:  Let you load/save SRAM and RTC data on the Memory Card
  . STATE Manager: Let you load/save Savestate and RTC data on the Memory Card
  The size of the created files are variables and depends on the ROM type.

Stop DVD Motor: save the DVD Lens life
SD/PSO reload: if you used SDLOAD to load the DOL, come back to SDLOAD menu



=[ CONTROLS ]=-
- Z Button let you come back to the menu when playing a game
- A is Gameboy Button A
- B is Gamenoy Button B
- START is Gameboy START Button
- Y is Gameboy SELECT Button



-=[ USER NOTES ]=-

The emulator is provided as a .dol which is a Gamecube Executable. You only need to load and run
the DOL on your GC or WII (Gamecube Pad needed) using various methods (Bootable DVD, SDLOAD,...)
If you have no idea on how to load&run a DOL, please go here on follow the available guides:
http://modyawii.tehskeen.com/  (Booting Homebrew Section)

If using SDCARD, roms must be placed in a directory named GBROMS, on the root of your SDCARD.
You can then use subdirectories as the file limit is 1000 per directory.

If using a DVD to load the roms, the format of the image you burned must be ISO9960
or you won't be able to read from it.



-=[ DEV NOTES ]=-

According to the GNU status of this project, the sourcecode MUST be included in any binary releases you made.
To recompile the sourcecode, you will need to have installed:
 . DevkitPPC environment
 . libOGC last sources
 . compiled libfreetype2
 
You also need to replace the gu_psasm.S file which is located in the /LIBBOGC directory (from the root of libogc source directory)
with the one included in this release and then recompile/reinstall libogc.

If you have no idea on how to compile DOLs , please refer to this thread:
http://www.tehskeen.com/forums/showthread.php?t=2968.



-=[ CREDITS ]=-

Original Gnuboy Sourcecode: Laguna & Gilgamesh
1.04 CVS fixes: Joshua_ from EFNet #gameboy
Generic LibOGC (GX,Sound,Inputs) & GUI display sourcecode: SoftDev
Gnuboy Porting Code & GUI design: Eke-Eke
DevkitPPC / LibOGC by Wntrmute & Shagkur
ZLIB by Jean-loup Gailly



