



               =---------------------------------------=
                SuperGCube - Nintendo Gamecube emulator
               
                  -- -- -- -- -- -- -- -- -- -- -- --
               
                   http://supergcube.sourceforge.net
               =---------------------------------------=
												 


SuperGCube is a continuation of the now-dead gamecube emulator GCube.
It is (for the time-being) Windows-only, but there is another similar
project called TuxCube, which is targeted at Linux.

Compatibility is still fairly low, so don't expect the stars.



Software requirements:
----------------------
* SDL library 1.2.7 or newer (won't work with older versions):
  www.libsdl.org
* zlib library 1.2.3 or newer (not tested with older versions):
  www.zlib.org
* GNU C compiler (preferably MinGW32 on CYGWIN)


Hardware requirements:
----------------------
* Processor: any x86-compatible that supports 3DNow and SSE3, Athlon64 recommended
* RAM: 512MB, at least 2GB recommended
* Video card must support at least the following extensions:
  - GL_EXT_texture_rectangle or GL_NV_texture_rectangle
  - GL_IBM_texture_mirrored_repeat
  - GL_ARB_imaging
  - GL_EXT_texture_lod_bias
  - GL_EXT_texture_filter_anisotropic


Building SuperGCube:
---------------
* Before compiling check Makefile for options.
* To compile just type 'make' or 'make release' (optimized)


Usage tips:
-----------
* The easiest way to use it on windows is to make a shortcut to gcube
  on the desktop and then just drop your GameCube files on it. You can
  also associate SuperGCube with .dol & .gcm files.


A few notes:
----------------------------------------
* In order to work properly, savestates must be placed in the same directory
  as the game they were created with.
* Some games will need specific settings to run. If a game doesn't work, try
  starting it with hle enabled or bigger refresh delay (-r value, eg. 900000).
* GCM's can be 'shrunk' with the supplied isopack utility. Shrinking removes
  blank space from the image (very few games use the full disk). For example,
  the size of 'The Legend Of Zelda - Four Swords' decreases from 1.4GB to
  255MB. Other images might or might not compress that well, depending on the
  contents.
* Only interpreter is implemented at the moment. That means it is rather slow.
  Plans for re-compiled emulation are in progress. Even using the current
  interpreted emulation mode, SuperGCube still runs many games faster than
  Dolphin, which has a re-compiler feature.
* I do try to inline functions whenever possible when writing source; I'd
  rather have an 8MB emulator that runs fast, than a 500KB emulator that is
  slower than molasses.
* Configuration file is kept in users' home directories:
	 e.g.: "/documents and settings/username/.gcube-0.4"
* Default GameCube => Keyboard mappings are (they are stored in 'gcuberc'):
	D-pad	=> Arrow keys
	Stick	=> Numpad (keys: 8,5,4,6)
	C-stick	=> keys: home,end,delete,page down
	A		=> q
	B		=> w
	L		=> a
	R		=> s
	X		=> z
	Y		=> x
	Z		=> c
	Start	=> Enter

  F1 will disable/enable texture caching (slow workaround until correct texture
     caching will be implemented).
  F2 will switch wireframe mode on / off.
  F3 switches between old and new rendering engine. The new one is at a early
     stage. Some games will look better with it, and others will look worse.
	F4 forces linear filtering on all textures.
	F5 makes all textures transparent. use if one texture occludes the view.
  F7 fixes dark textures in custom robo.
  F8 enables/disables opengl generated mipmaps. By default, gcube will use
     mipmaps supplied by emulated program.
	F9 will create a screenshot.
  F11 creates a savestate. Savestates must reside in the same directory
     as the game they were created with.
  F12 loads a savestate.


Troubleshooting
---------------
* Problem: I get the message "Run-time error '53': File not found" when
			starting a game through GCubeFront.

	- Solution:
		Make sure GCube.EXE is in the same directory as GCubeFront.exe.


* Problem: Nothing happens when I try to start a game through GCubeFront.

	- Solution 1:
		Make sure the following DLLs are in the same directory as GCube:
			cygwin1.dll
			cygncurses-8.dll
			cygz.dll
			SDL.dll
			zlib1.dll
	
	- Solution 2:
		Make sure your computer meets the hardware/software requirements
			for your release of SuperGCube.


* Problem: The keys don't seem to work. I can't control my game.

	- Solution:
		This is most likely due to a missing 'gcuberc' file. This file
			stores the key mappings for your virtual controller. Exit
			SuperGCube (via the 'X' in the upper-right corner or by
			pressing Esc), and SuperGCube will automatically create
			the 'gcuberc' file if it is missing. Then restart your
			game, and the controls should work.


* Problem: SSBM "hangs" when I try to start a match. The FPS remains
			normal, SuperGCube is still responsive, but nothing happens
			in the game.

	- Solution:
		This is due to a quirk in SuperGCube's interpreter, and should
			be fixed soon; in the meantime, to prevent this issue,
			simply go to the Language menu before every match and
			change the language, or change it and then change it back.
			You should then be able to proceed with your battle.



Credits...
----------
Big thanks goes to:
* GCube author, monk, for his great work, and for releasing his
  source.
* Dolwin authors, org and hotquick. If they wouldn't release
  sources of their emulator, GCube wouldn't exist.
* gropeaz / hitmen for Yet Another Gamecube Documentation,
  also to everyone who contributed to it in any way.
* Frank Willie (phx) for PowerPC disassembler.
* Every GC homebrew developer releasing sources.
* Metalmurphy for GCube homepage and EXEmu.net staff for hosting it.
* Adam Green for helping me out with the Mac OS X port.
* Dolphin authors, F|RES, ector and schibo, for the Dolphin sources. It helped
  me improve the emu, as well as kill some ugly bugs.


Thanks to Bharat Kambalur for the great icons and logo!
	bharatkambalur@gmail.com
	http://logopond.com/members/profile/showcase/19648



  Keep in mind this is a beta-quality product. It hasn't been thoroughly
tested and may contain bugs. Patches and suggestions are always welcome.

  If you want to report a bug, ask a question or share a solution to a
common problem, check out the SuperGCube homepage at http://supergcube.sourceforge.net/

spartan11-7@users.sourceforge.net

spartan11-7
