Merge branch 'dev'

[picodrive.git] / platform / gp2x / PicoDrive.man.txt

[About]\r
This is yet another Megadrive / Genesis / Sega CD / Mega CD emulator, which was written having ARM-based handheld devices in mind (such as PDAs, smartphones and handheld consoles like GP2X of course). The critical parts (renderer, 68K and Z80 cpu interpreters) and some other random code is written in ARM asm, other code is C. The base code originates from Dave's (fdave, finalburn) PicoDrive 0.30 for Pocket PC. The Sega/Mega CD code is roughly based on Stephane Dallongeville's Gens.\r
\r
PicoDrive is the first emulator ever to properly emulate Virtua Racing and it's SVP chip.\r
\r
\r
For help / comments / questions visit GP32X boards at:\r
http://www.gp32x.com/board/\r
\r
\r
[How to make it run]\r
Copy PicoDrive.gpe, pico940_v3.bin and mmuhack.o to any place in your filesystem (all 3 files must be in the same directory) and run PicoDrive.gpe. Then load a ROM and enjoy! ROMs can be in .smd or .bin format and can be zipped.\r
\r
If the game has graphic problems, make sure you use "16bit accurate renderer" (press Y). If it still doesn't work, try clean copy of the emulator, as you may have config problems.\r
\r
\r
[How to run Sega/Mega CD games]\r
To play any game, you need BIOS files. These files must be copied to the same directory as PicoDrive.gpe. Files can be named as follows:\r
US: us_scd1_9210.bin us_scd2_9306.bin SegaCDBIOS9303.bin\r
EU: eu_mcd1_9210.bin eu_mcd2_9303.bin eu_mcd2_9306.bin\r
JP: jp_mcd1_9112.bin jp_mcd1_9111.bin\r
these files can also be zipped.\r
\r
The game must be dumped to ISO format, but BIN can be used too. If you want CD music, you must use ISO+mp3 files. Audio from BIN files won't be read at all due to SD access issues. Also BIN files are usually larger, so it's better to use ISO. ISO+mp3 files can be named similarly as for other emus.\r
Here are some examples:\r
\r
SonicCD.iso\r
SonicCD_02.mp3\r
SonicCD_03.mp3\r
...\r
\r
Sonic the Hedgehog CD (US) - Track 01.iso\r
Sonic the Hedgehog CD (US) - Track 02.mp3\r
Sonic the Hedgehog CD (US) - Track 03.mp3\r
...\r
\r
ISO files can also be zipped (but not mp3 files, as they are already compressed). Note that this can cause very long loading times, which may take up to several minutes. File naming is similar as with uncompressed ISOs.\r
Example:\r
\r
SonicCD.zip\r
SonicCD_02.mp3\r
SonicCD_03.mp3\r
...\r
\r
Notes:\r
If the game hangs after Sega logo, you may need to enable "better sync" and/or "Scale/Rot. fx" options, found in "Sega/Mega CD options" submenu, and then reset the game.\r
If FMV game performance is poor, try adjusting "ReadAhead buffer" to something like 2048K.\r
\r
\r
[Configuration]\r
1. "Renderer"\r
8bit fast:\r
This enables alternative heavily optimized tile-based renderer, which renders pixels not line-by-line (this is what accurate renderers do), but in 8x8 tiles, which is much faster. But because of the way it works it can't render any mid-frame image changes (raster effects), so it is useful only with some games.\r
\r
Other two are accurate line-based renderers. The 8bit is faster but does not run well with some games like Street Racer.\r
\r
2. "Scaling"\r
"hw" means GP2X hardware scaler, which causes no performance loss, but scaled image looks a bit blocky. "sw" means software scaling, which uses pixel averaging and may look a bit nicer, but blurry. Horizontal scaling is only for games which use so called "32 column mode" (256x224 or 256x240), and scales image width to 320 pixels. Vertical scales height to 240 for games which use height 224 (most of them).\r
\r
3. "Show FPS"\r
Self-explanatory. Format is XX/YY, where XX is the number of rendered frames and YY is the number of emulated frames per second.\r
\r
4. "Frameskip"\r
How many frames to skip rendering before displaying another. "Auto" is recommended.\r
\r
5. "Enable sound"\r
Does what it says. You must enable at least YM2612 or SN76496 (in advanced options, see below) for this to make sense.\r
\r
6. "Sound Quality"\r
Sound rate and stereo mode. If you want 44100Hz sound, it is recommended to enable the second core (next option).\r
\r
7. "Use ARM940 core for sound"\r
This option causes PicoDrive to use ARM940T core (GP2X's second CPU) for sound (i.e. to generate YM2612 samples) to improve performance noticeably.\r
\r
8. "6 button pad"\r
If you enable this, games will think that 6 button gamepad is connected. If you go and reconfigure your keys, you will be able to bind X,Y,Z and mode actions.\r
\r
9. "Region"\r
This option lets you force the game to think it is running on machine from the specified region, or just to set autodetection order. Also affects Sega/Mega CD.\r
\r
10. "Use SRAM/BRAM savestates"\r
This will automatically read/write SRAM (or BRAM for Sega/Mega CD) savestates for games which are using them. SRAM is saved whenever you pause your game or exit the emulator.\r
\r
11. "Confirm savestate"\r
Allows to enable confirmation on savestate saving (to prevent savestate overwrites), on loading (to prevent destroying current game progress), and on both or none.\r
\r
12. "Save slot"\r
This is a slot number to use for savestates. This can also be configured to be changed with a button (see "key configuration").\r
\r
13. "GP2X CPU clocks"\r
Here you can change clocks of both GP2X's CPUs. Larger values increase performance. There is no separate option for the second CPU because both CPUs use the same clock source. Setting this option to 200 will cause PicoDrive NOT to change GP2X's clocks at all (this is if you use external program to set clock).\r
\r
14. "[Sega/Mega CD options]"\r
Enters Sega/Mega CD options menu (see below).\r
\r
15. "[advanced options]"\r
Enters advanced options menu (see below).\r
\r
16. "Save cfg as default"\r
If you save your config here it will be loaded on next ROM load, but only if there is no game specific config saved (which will be loaded in that case).\r
\r
17. "Save cfg for current game only"\r
Whenever you load current ROM again these settings will be loaded (squidgehack and RAM settings will not take effect until emulator is restarted).\r
\r
\r
Advanced configuration\r
----------------------\r
\r
Enter [advanced options] in config menu to see these options.\r
\r
1. "Gamma correction"\r
Alters image gamma through GP2X hardware. Larger values make image to look brighter, lower - darker (default is 1.0).\r
\r
2. "A_SN's gamma curve"\r
If this is enabled, different gamma adjustment method will be used (suggested by A_SN from gp32x boards). Basically it makes difference for dark and bright colors.\r
\r
3. "Perfect vsync"\r
This one adjusts the LCD refresh rate to better match game's refresh rate and starts synchronizing rendering with it. Should make scrolling smoother and eliminate tearing.\r
\r
4. "Emulate Z80"\r
Enables emulation of Z80 chip, which was mostly used to drive the other sound chips. Some games do complex sync with it, so you must enable it even if you don't use sound to be able to play them.\r
\r
5. "Emulate YM2612 (FM)"\r
This enables emulation of six-channel FM sound synthesizer chip, which was used to produce sound effects and music.\r
\r
6. "Emulate SN76496 (PSG)"\r
This enables emulation of additional sound chip for additional effects.\r
\r
Note: if you change sound settings AFTER loading a ROM, you may need to reset game to get sound. This is because most games initialize sound chips on startup, and this data is lost when sound chips are being enabled/disabled.\r
\r
7. "gzip savestates"\r
This will always apply gzip compression on your savestates, allowing you to save some space and load/save time.\r
\r
8. "Don't save last used ROM"\r
This will disable writing last used ROM to config on exit (what might cause SD card corruption according to DaveC).\r
\r
9. "craigix's RAM timings"\r
This overclocks the GP2X RAM chips, but may cause instability. Recommended if you use the second core for sound. Needs emulator restart to take effect.\r
See this thread:\r
http://www.gp32x.com/board/index.php?showtopic=32319\r
\r
10. "squidgehack"\r
Well known way to improve the GP2X performance. You must restart the emulator for the change of this option to take effect.\r
\r
\r
Sega/Mega CD options \r
--------------------\r
\r
1,2,3. "USA/EUR/JAP BIOS"\r
These options just show if your BIOS files were correctly detected by the emulator (it shows the filename it is using). If so, you can press Start to test your BIOS.\r
\r
4. "CD LEDs"\r
The Sega/Mega CD unit had two blinking LEDs (red and green) on it. This option will display them on top-left corner of the screen.\r
\r
5. "CDDA audio"\r
This option enables CD audio playback.\r
\r
6. "PCM audio"\r
This enables 8 channel PCM sound source. It is required for some games to run, because they monitor state of this audio chip.\r
\r
7. "ReadAhead buffer"\r
This option can prefetch more data from the CD image then requested by game (to avoid accessing card later), what can improve performance in some cases.\r
"OFF" is the recommended setting.\r
\r
8. "Save RAM cart"\r
Here you can enable 64K RAM cart. Format it in BIOS if you do.\r
\r
9. "Scale/Rot. fx"\r
The Sega/Mega CD had scaling/rotation chip, which allows effects similar to "Mode 7" effects in SNES. Unfortunately emulating it is slow, and very few games used it, so it's better to disable this option, unless game really needs it.\r
\r
10. "Better sync"\r
This option is similar to "Perfect synchro" in Gens. Some games require it to run, for example most (all?) Wolfteam games, and some other ones. Don't use it for games which don't need it, it will just slow them down.\r
\r
\r
Key configuration\r
-----------------\r
\r
Select "Configure controls" from the main menu. Then select "Player 1" and you will see two columns. The left column lists names of Genesis/MD controller buttons, and the right GP2X ones, which are assigned to them. If you bind 2 different GP2X buttons to the same action, you will get a combo (which means that you will have to press both buttons for that action to happen.\r
\r
\r
[Other important stuff]\r
When you use both GP2X CPUs, keep in mind that you can't overclock as high as when using ARM920 only. For example my GP2X when run singlecore can reach 280MHz, but with both cores it's about 250MHz. When overclocked too much, it may start hanging and producing random noise, or causing ARM940 crashes ("940 crashed" message displayed).\r
\r
PicoDrive is not a mp3 player, so all mp3s MUST be encoded at 44.1kHz stereo. Badly encoded mp3s can cause various kind of problems, like noises, incorrect playback speeds, not repeating music or even prevent game from starting. Use lower bitrate for better performance (96 or 128kbps CBRs recommended). Due to internal implementation mp3s must not be larger that ~15MB (15548416 bytes). Larger mp3s will not be fully loaded.\r
\r
RAM timings option is good for dualcore operation (it is disabled by default because it doesn't work on every GP2X, so enable it in advanced options).\r
\r
\r
[Cheat support]\r
To use GG/patch codes, you must type them into your favorite text editor, one per line. Comments may follow code after a whitespace. Only GameGenie and Genecyst patch formats are supported.\r
Examples:\r
\r
Genecyst patch (this example is for Sonic):\r
\r
00334A:0005 Start with five lives\r
012D24:0001 Keep invincibility until end of stage\r
009C76:5478 each ring worth 2\r
009C76:5678 each ring worth 3\r
...\r
\r
Game Genie patch (for Sonic 2):\r
\r
ACLA-ATD4 Hidden palace instead of death egg in level select\r
...\r
\r
Both GG and patch codes can be mixed in one file.\r
\r
When the file is ready, name it just like your ROM file, but with additional .pat extension, making sure that case matches.\r
\r
Examples:\r
\r
ROM: Sonic.zip\r
PATCH FILE: Sonic.zip.pat\r
\r
ROM: Sonic 2.bin\r
PATCH FILE: Sonic 2.bin.pat\r
\r
Put the file into your ROMs directory. Then load the .pat file as you would a ROM. Then Cheat Menu Option should appear in main menu.\r
\r
\r
[What is emulated?]\r
Genesis/MegaDrive:\r
main 68k @ 7.6MHz: yes, Cyclone core\r
z80 @ 3.6MHz: yes, DrZ80 core\r
VDP: yes, except some quirks not used by games\r
YM2612 FM: yes, optimized MAME core\r
SN76489 PSG: yes, MAME core\r
SVP chip: yes! This is first emu to ever do this.\r
Some in-cart mappers are supported too.\r
\r
Sega/Mega CD:\r
another 68k @ 12.5MHz: yes, Cyclone too\r
gfx scaling/rotation chip (custom ASIC): yes\r
PCM sound source: yes\r
CD-ROM controller: yes (mostly)\r
bram (internal backup RAM): yes\r
RAM cartridge: yes\r
\r
\r
[Problems / limitations]\r
* 32x is not emulated.\r
* Various VDP quirks (window bug, scroll size 2, etc.) are not emulated, as very few games use this (if any at all).\r
* The emulator is not 100% accurate, so some things may not work as expected.\r
\r
\r
[Credits]\r
This emulator is made of the code from following people/projects:\r
\r
notaz\r
GP2X, UIQ, PSP, Gizmondo ports, CPU core hacks,\r
lots of additional coding (see changelog).\r
Homepage: http://notaz.gp2x.de/\r
\r
Dave\r
Cyclone 68000 core, Pico emulation library\r
Homepage: http://www.finalburn.com/\r
\r
Reesy & FluBBa\r
DrZ80, the Z80 interpreter written in ARM assembly.\r
Homepage: http://reesy.gp32x.de/\r
\r
Tatsuyuki Satoh, Jarek Burczynski, MAME development\r
software implementation of Yamaha FM sound generator\r
\r
MAME development\r
Texas Instruments SN76489 / SN76496 programmable tone/noise generator\r
Homepage: http://www.mame.net/\r
\r
Stephane Dallongeville\r
Gens, MD/Mega CD/32X emulator. Most Sega CD code is based on this emu.\r
\r
Helix community\r
Helix mp3 decoder\r
\r
\r
[Additional thanks]\r
* Charles MacDonald (http://cgfm2.emuviews.com/) for old but still very useful\r
  info about genesis hardware.\r
* Steve Snake for all that he has done for Genesis emulation scene.\r
* Tasco Deluxe for his reverse engineering work on SVP and some mappers.\r
* Bart Trzynadlowski for his SSFII and 68000 docs.\r
* Haze for his research (http://haze.mameworld.info).\r
* Lordus, Exophase and Rokas for various ideas.\r
* Nemesis for his YM2612 research.\r
* Mark and Jean-loup for zlib library.\r
* ketchupgun for the skin.\r
* rlyeh and all the other people behind the minimal library.\r
* Squidge for his famous squidgehack(tm).\r
* Dzz for his ARM940 sample code.\r
* GnoStiC & Puck2099 for USB joystick support.\r
* Hermes PS2R, god_at_hell for the CpuCtrl library.\r
* A_SN for his gamma code.\r
* craigix for supplying the GP2X hardware and making this port possible.\r
* Alex for the icon.\r
* All the people from gp32x boards for their support.\r
* Anyone else I forgot. You know who you are.\r
\r
\r
[Disclaimer]\r
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \r
\r
SEGA/Genesis/MegaDrive/SEGA-CD/Mega-CD/32X are trademarks of Sega Enterprises Ltd.\r
\r