,`,,`,,`,,`,,`,,`,,`,,
 
                                   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...)
See changelog.txt for the whole history.

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


-=[ FEATURES ]=-

 . Gameboy and Gameboy Color emulation with sound
 . DVD, USB (Wii only) & SDCARD support for ROM files loading
 . Freeze State support (load & save)
 . SRAM/RTC support (load & save)
 . support for 8MB roms
 . support for zipped (.zip) roms
 . support for alternate Mono Gameboy palettes
 . RTC synchro
 . Load/Save SRAM and FreezeState files (compressed) from/to Memory Card & SDCARD
 . SDLOAD or IPL reboot option
 . Wiimote/Nunchuk/Classic controller support (Wii version only)
 . Automatic SRAM/FreezeState
 . Video mode supported: 480i,480p & 576i (automatic detection)



-=[ REQUIREMENTS ]=- 

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


-=[ USER NOTES ]=-

* gnuboy_cube.dol is the Gamecube version of this program. You only need to load and run
this DOL on your GC or WII (in GC compatibility mode) 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)

* gnuboy_wii.dol is the Wii version of the program. It has been compiled to work in Wii mode, featuring extra feature
such as Wiimote/Nunchuk & Classic controller support. To run this on your Wii, you will need to install the
Homebrew Channel (http://hbc.hackmii.com/). Once installed, rename gnuboy_wii.dol as boot.dol and copy this file on your sdcard,
in /apps/gnuboy for example. Icon.png and meta.xml should also be placed in the same directory.


ROMS can be loaded from a SDCARD, either through a SD-adapter in MCARD slot (Gamecube version only), or through the 
native Wii SD slot (WIi version only). ROMS must be copied on your SDCARD in the following directory: /gnuboy/roms

ROMS can also be loaded from a ISO9660 DVD. A modchip is required in gameCube mode. On teh Wii, no modchip is required but you will
need to install the DI Stub before you can access DVD-/+R. More infos on HackMii: http://hackmii.com/2008/08/libdi-and-the-dvdx-installer/
The maximal readable size is 1.35GB on Gamecube and 4.7GB on Wii (in GC compatible mode).


IMPORTANT: When putting roms either on DVD or SDCARD, it is recommended to use subdirectories as there is 
	   a limit of 1000 files per directory.



-=[ CONTROLS ]=-

** GAMECUBE PAD ***

- 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

** WIIMOTE/NUNCHUK/CLASSIC **

- HOME Button let you come back to the menu when playing a game
- Gameboy Button A is Button 2 (WIIMOTE only), A (WIIMOTE+NUNCHUK) or A (CLASSIC)
- Gamenoy Button B is Button 1 (WIIMOTE only), B (WIIMOTE+NUNCHUK) or B (CLASSIC)
- Gameboy START Button is Button PLUS
- Gameboy SELECT Button is Button MINUS

-=[ MENU ]=-

Press A (or 1) or to select a menu item.
Press B (or 2) to go back from a sub-menu.


  Play Game :    Run the game you just loaded or return to game
  -----------------------------------------------------------------------------------


  Game Info :    Some informations about the ROM
  -----------------------------------------------------------------------------------


  Hard Reset:    Reset emulator
  -----------------------------------------------------------------------------------


  Load New Game:
  -----------------------------------------------------------------------------------

  . Load Recent let you browse a ROM history list with the ten last opened ROM files.
 This is only available for ROM files previously loaded from SDCARD.

  . Load from SD let you browse the SDCARD. 

  . Load from USB let you browse the USB strorage device. 

  . Load from DVD let you browse the DVD. 

  . Stop DVD Motor will stop the DVD motor and the disc from spinning during playtime

  Pressing B will make you going up one directory while navigating.


  Emulator Options:
  -----------------------------------------------------------------------------------

  . Aspect: let you modify the display aspect ratio:
     - ORIGINAL: original ratio (1.11:1) & resolution
     - SCALED: the original aspect ratio is maintaned but display is scaled to fit screen vertical height (default)
     - STRETCH: display is stretched to fill the screen (640x480)

  . 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)

  . Palette: Display some colors in Mono GB (Try Kirby's palette)

  . RTC Synchro: enable RTC synchronization with current system clock on SRAM load 

  . Auto SRAM: automatically load & save SRAM file when loading a new game or leaving application

  . Auto Freeze: automatically load & save FreezeState file when loading a new game or leaving application


  Memory Manager:
  -----------------------------------------------------------------------------------

  . SRAM Manager:  Let you load/save SRAM and RTC data from/to the selected device
  . STATE Manager: Let you load/save Savestate data from/to the selected device
  
  . Device: Let you choose the device to use: FAT (automatically detected) or MCARD
 
  The size of the created files is variable and depends on the ROM type.

  IMPORTANT:
   
   1/ when using NGC Memory Card in SLOTA, some mounting errors may occur. In this case,
      remove and insert the Memory Card again before trying to save/load anything.

   2/ when using FAT device, the directory /gnuboy/saves is automatically created


  Return to Loader:
  -----------------------------------------------------------------------------------
     go back to SDLOAD/PSOLOAD (Gamecube) or TP Loader/Homebrew Channel (Wii)

  System Reboot
  -----------------------------------------------------------------------------------
     reset the console (Gamecube) or return to System menu (Wii)



-=[ DEV NOTES ]=-

According to the GNU status of this project, the source code MUST be made available to anyone as soon
as you have modified it and released a binary. 
To recompile the source code, you will need to be familiar with development environment setup.
If you don't, you might look at wiibrew or tehskeen's forum. 

First, you will have to download and install the following tools/libraries: 
1.	the last version of Devkitpro and DevkitPPC. Windows user should directly run the AutoInstaller version 
2.	the CVS version of libogc. 
3.	the last version of libfat.
You can also get and compile the current source from CVS repository 
4.	the last libDI source code. 

Once you are done, grab the current gnuboy-gx source code from SVN (http://code.google.com/p/gnuboy-gx/source/checkout)
then launch compile_all.bat from msys (installed with devkitpro) 


-=[ 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 & extra features: Eke-Eke
Mono Gameboy palettes addition: Askot
DevkitPPC from Dave Murphy (WinterMute)
LibOGC by Michael Wiedenbauer (shagkur),Dave Murphy (WinterMute) & others
ZLIB by Jean-loup Gailly




