
GuineaPig
---------

GuineaPig is an emulator system for numerous classic game consoles, for
running on Palm OS (with Zodiac enhancements where available.)

SEGA Genesis, SEGA Master System and SEGA GameGear -- copyright SEGA Inc.
NEC TurboGrafx -- copyright NEC.

No warranty is implied whatsoever; no implication to ownership of the
consoles is implied.. this is merely a collection of emulators, written
by other people, ported to the GuineaPig framework for Palm OS.

The emulator "cores" are under the GPL license; the GuineaPig frontend
and launcher, for legal reasons, is not open source at this time. We await
licensing changes for dependant SDK's for that to occur.

For more complete documentation, information, message boards, links,
etc etc, please see the home webpage:

http://www.codejedi.com/guineapig

The website is very useful for instructions!

Installation
------------
1) Send GuineaPig.prc to your handheld
2) Run the application (this will do some basic error checks and create
   a directory on your SD card, Memory Stick, Compact Flash, or whatever. An
   expansion card of some sort is REQUIRED for GuineaPig.)
3) Send the .emu files over to your handheld (the ones you want, or all
   of them. For instance, genesis.emu is needed to run SEGA Genesis games.
   - I suggest using a USB Card Reader/Writer -- they're very inexpensive and
     fast. (I picked up one for $20USD!)
   - You can also use Card Export application on your handheld (to make your
     handheld look like a USB Card Writer to your computer), or on a Sony Clie
     you can use MemStick Export. There are other tools such as ReceiveIt
     (shareware) and numerous freeware tools to let you tell Hotsync where to
     send files to on your SD card during hotsync, IR beaming, etc.
   - .emu files, along with any ROMs, should be sent to
     /PALM/Programs/GuineaPig on your expansion media
4) Send over any ROM files you wish to try; note that GuineaPig will manage
   .smd files (Sega Genesis ROMs can also end with another extension such
   as .bin, but that is not managed due to conflicts with other applications.)
   and so you can directly Hotsync over .smd files and they'll go to the right
   place, though the hotsync will be slow!

Audio Note
----------
Note that by default Audio is disabled, since GuineaPig isn't the fastest
ship in the dock, and audio slows things down. However, note that in some
games, the audio system is required to be operating..

Example: XMen -- Adamantium Rage on the SEGA Genesis uses the Z80 processor
of the audio system for some setup, and so will not run unless Audio is
enabled.

Most games are fine with audio being disabled, but if a game fails to run,
try turning on audio. That'll slow it down some, but it may also bring it
to life!

RAM Note
--------
GuineaPig uses a LOT of runtime memory. Not *storage memory* -- runtime
memory. Only more recent devices provide a large enough amount of runtime RAM
for GuineaPig to operate. A Zire 71 and Tungsten T1 cannot run GuineaPig's
Genesis or TG16 emulators for instance, but a Zodiac, T|T3, Sony TH55,
Sony UX50, etc etc can just fine. It depends on the ROM and your device.

It may help to pinhole reset your device before and after running GuineaPig
to ensure maximum runtime RAM is available. (Zire 72 is on the fence, so it
helps here!)

For a Treo 600, keep Wireless Mode off while running GuineaPig, or you won't
have enough runtime RAM.

Ensure background audio players and any Hacks are disabled.

Not all devices can run GuineaPig; OS5 is required, and only more recent
OS5 devices are capable. Sorry!

Zodiac Note
-----------
With version 012 and later, some modules support full screen smooth blitting
using the Zodiac hardware. As of version 012, Genesis and TG16 offer this
functionality.

You can always check the "Scale" option in the GuineaPig ROM picker; on a
Zodiac, this will attempt hardware scaling where available.

NOTE that while using Zodiac mode, the entire screen is blitted to, covering
up any controls such as the Frameskip changer. You can still tap with your
finger on the control to bring it up and use it.. you just can't see it until
you tap on it :) You'll get used to it, and its worth it since things just
look so good when in fullscreen :)

Sony Note
---------
Note that most older Sony units cannot use Audio (as of beta 003) due to
Sony's proprietary audio API - Bad Sony! However, more recent units can use
the audio (such as the UX-50). So by default Audio is turned off for Sony
units, though you can turn it on if you like. If you get a crash, your unit
is using the bad Sony API and so no audio...

Starting Games
--------------
1) Run the emu
2) Pick a Cartridge ROM to run from the listing
3) Check Scale and/or Audio if you want them; see notes above!
4) Hit Go! to fire up the emulator
   o Note that you need the appropriate .emu files in place; if you invoke
     a Genesis ROM, then genesis.emu has to be present or it'll error or
     crash!
5) Wait a moment; some games are slow or need to boot up for a moment, or
   maybe GuineaPig is setting itself up; but even on slower devices, a game
   should do *something* within a second or two; if not, it may not be
   compatible with GuineaPig!

Controls
--------
They vary by device, so noodle around to figure them out ;)

On the Zodiac, the Gray button and pressing the joystick in should count
as the Start button as well, so just use the gray button for Start :)

Jeff
Codejedi Inc.
