release 1.85
[picodrive.git] / platform / base_readme.txt
index 013320e..0b2748e 100644 (file)
@@ -4,25 +4,15 @@ PicoDrive 1.xx
 About\r
 -----\r
 \r
-#ifdef PSP\r
-This is yet another Megadrive / Genesis emulator for PSP, but with\r
-Sega CD / Mega CD support. Although it has been originally written having\r
-ARM CPU based devices in mind, it has now been ported to PSP too, by\r
-replacing ARM specific parts with portable C code.\r
-The base code originates from Dave's (fdave, finalburn) PicoDrive 0.30 for\r
-Pocket PC. The Sega/Mega CD code is roughly based on Stephane Dallongeville's\r
-Gens.\r
-#else\r
 This is yet another Megadrive / Genesis / Sega CD / Mega CD / 32X / SMS\r
 emulator, which was written having ARM-based handheld devices in mind\r
-(such as PDAs, smartphones and handheld consoles like GP2X and Gizmondo\r
-of course).\r
+(such as smartphones and handheld consoles like GP2X and Pandora).\r
+\r
 The emulator is heavily optimized for ARM, features assembly cores for\r
 68k, Z80 and VDP chip emulation, also has dynamic recompilers for SH2 and\r
 SSP16 (for 32X and SVP emulation). It was started by Dave (aka fdave,\r
 finalburn author) as basic Genesis/Megadrive emulator for Pocket PC,\r
-then taken over by notaz and developed primarily for GPH devices.\r
-#endif\r
+then taken over and expanded by notaz.\r
 \r
 PicoDrive is the first emulator ever to properly emulate Virtua Racing and\r
 it's SVP chip.\r
@@ -54,36 +44,26 @@ which one GAME* directory to use).
 \r
 If you are on 1.5, there is a separate KXploited version for it.\r
 #endif\r
-#ifdef UIQ\r
-Copy SIS and some ROMs to any directory in your memory stick, and install the SIS.\r
-Then load a ROM and enjoy! ROMs can be in .smd or .bin format and can be zipped.\r
-#endif\r
 #ifdef PANDORA\r
 Just copy the .pnd to <sd card>/pandora/menu or <sd card>/pandora/desktop.\r
 #endif\r
-#ifndef UIQ\r
 \r
 This emulator has lots of options with various tweaks (for improved speed mostly),\r
-but it should have best compatibility in it's default config. If suddently you\r
+but it should have best compatibility in it's default config. If suddenly you\r
 start getting glitches or change something and forget what, use "Restore defaults"\r
 option.\r
-#endif\r
 \r
 \r
 How to run Sega/Mega CD games\r
 -----------------------------\r
 \r
-To play any game, you need BIOS files. These files must be copied to\r
-#ifdef UIQ\r
-D:\other\PicoDrive\ directory.\r
-#else\r
+To play any CD game, you need BIOS files. These files must be copied to\r
 #ifdef PANDORA\r
-<sd card>/pandora/appdata/PicoDrive/ directory\r
+<sd card>/pandora/appdata/picodrive/ directory\r
 (if you run PicoDrive once it will create that directory for you).\r
 #else\r
 the same directory as PicoDrive files.\r
 #endif\r
-#endif\r
 Files can be named as follows:\r
 \r
 US: us_scd1_9210.bin us_scd2_9306.bin SegaCDBIOS9303.bin\r
@@ -91,79 +71,31 @@ EU: eu_mcd1_9210.bin eu_mcd2_9303.bin eu_mcd2_9306.bin
 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/CSO+MP3/WAV or CUE+BIN format. When using\r
-CUE/BIN, you must load .cue file from the menu, or else the emu will not find\r
-audio tracks.\r
-CUE/BIN usually takes a lot of space, so it can be converted to cue/cso/mp3 by\r
-#ifdef PANDORA\r
-using bin_to_cso_mp3 tool, which can be downloaded from:\r
-http://notaz.gp2x.de/releases/misc/bin_to_cso_mp3.zip\r
-See readme in the bin_to_cso_mp3/ directory for details.\r
-#else\r
-using bin_to_cso_mp3 tool, which is included with the emulator. See readme in\r
-the bin_to_cso_mp3/ directory for details.\r
-#endif\r
-\r
-ISO+mp3 files can be named similarly as for other emus.\r
-Here are some examples:\r
-\r
-SonicCD.iso             data track\r
-SonicCD_02.mp3          audio track 1 (CD track 2)\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
-In case there is a .cue file with properly specified files names in it,\r
-file naming doesn't matter. Just be sure to load .cue from the menu.\r
-\r
-It is very important to have the MP3s encoded at 44kHz sample rate and they\r
-must be stereo, or else they will play too fast/slow or won't play at all.\r
-Be sure NOT to use anything but classic mp3 format (don't use things like\r
-mp3pro).\r
-\r
-ISO files can also be .cso compressed or zipped (but not mp3 files, as they\r
-are already compressed). CSO will cause slightly longer loading times, and\r
-is not very good for FMV games. Zipping ISOs is not recommended, as it will\r
-cause very long (several minute) loading times, and make some games\r
-unplayable. File naming is similar as with uncompressed ISOs.\r
-Example:\r
-\r
-SonicCD.cso             data track\r
-SonicCD_02.mp3          audio track 1 (CD track 2)\r
-SonicCD_03.mp3\r
-...\r
+The game must be dumped to CUE+BIN or CUE+ISO format.\r
+ISO/CSO+MP3/WAV is also supported, but may cause problems.\r
+When using CUE/BIN, you must load .cue file from the menu, or else\r
+the emu will not find audio tracks.\r
 \r
 \r
 Other important stuff\r
 ---------------------\r
 \r
-* Sega/Mega CD: If the game hangs after Sega logo, you may need to enable\r
-  "better sync" and/or "Scale/Rot. fx" options, found in "Sega/Mega CD options"\r
-  submenu, and then reset the game. Some other games may also require\r
-  "CDDA audio" and "PCM audio" to be enabled to work (enabled by default).\r
-  Incorrectly named/missing mp3s may also be the cause.\r
-* Sega/Mega CD: If the background music is missing, you might have named your\r
-  MP3s incorrectly. Read "How to run Sega/Mega CD games" section again.\r
-* Sega/Mega CD: If the game music plays too fast/too slow/out of sync, you have\r
-  encoded your MP3s incorrectly. You will have to re-encode and/or resample them.\r
-  PicoDrive is not a mp3 player, so all mp3s MUST be encoded at 44.1kHz stereo.\r
-  Badly encoded mp3s can cause various kind of problems, like noises, incorrect\r
-  playback speeds, not repeating music or even prevent game from starting.\r
-  Some games (like Snatcher) may hang in certain scenes because of this.\r
-  Some mp3 rippers/encoders remove silence and beginning/end of audio tracks,\r
-  what causes audio desyncs and/or mentioned problems.\r
-  If you have cue/bin rip, you can use the bin_to_cso_mp3 tool (included with\r
-  the emulator) to make a proper iso/mp3 rip.\r
-* Sega/Mega CD: If your games hangs at the BIOS screen (with planets shown),\r
-  you may be using a bad BIOS dump. Try another from a different source.\r
-* Some Sega/Mega CD games don't use Z80 for anything, but they leave it active,\r
-  so disabling Z80 manually (in advanced options) improves performance.\r
-* Use lower bitrate for better performance (96 or 128kbps CBRs recommended).\r
+* Sega/Mega CD: If the background music is missing, the CD image format may be\r
+  wrong. Currently .cue/bin is recommended. Be aware that there are lots of bad\r
+  dumps on the web, and some use mp3 format for audio, which often causes\r
+  problems (see below).\r
+* While iso/mp3 format is supported, it's not recommended to use.\r
+  Some of many problems with mp3 are listed below:\r
+  * MP3s may be named incorrectly and will not play.\r
+  * The game music may play too fast/too slow/out of sync, which means they\r
+    are encoded incorrectly. PicoDrive is not a mp3 player, so all mp3s MUST\r
+    be encoded at 44.1kHz stereo.\r
+* Sega/Mega CD: If your games hang at the BIOS screen (with planets shown),\r
+  you may be using a bad BIOS dump. Try another from a different source,\r
+  like dumping it from your own console.\r
 #ifdef GP2X\r
+* What using mp3s, use lower bitrate for better performance (96 or 128kbps\r
+  CBRs recommended).\r
 * GP2X F100/F200: When you use both GP2X CPUs, keep in mind that you can't\r
   overclock as high as when using ARM920 only. For example my GP2X when run\r
   singlecore can reach 280MHz, but with both cores it's about 250MHz. When\r
@@ -177,9 +109,6 @@ Other important stuff
 Configuration\r
 -------------\r
 \r
-#ifdef UIQ\r
-#include "config.txt"\r
-#else\r
 @@0. "Save slot"\r
 This is a slot number to use for savestates, when done by a button press outside\r
 menu. This can also be configured to be changed with a button\r
@@ -214,18 +143,6 @@ Allows to enable confirmation on savestate saving (to prevent savestate overwrit
 on loading (to prevent destroying current game progress), and on both or none, when\r
 using shortcut buttons (not menu) for saving/loading.\r
 \r
-#ifdef GP2X\r
-@@0. "GP2X CPU clocks"\r
-Here you can change clocks of both GP2X's CPUs. Larger values increase performance.\r
-There is no separate option for the second CPU because both CPUs use the same clock\r
-source. Setting this option to 200 will cause PicoDrive NOT to change GP2X's clocks\r
-at all (this is if you use external program to set clock).\r
-#endif\r
-#ifdef PSP\r
-@@0. "CPU/bus clock"\r
-This allows to change CPU and bus clocks for PSP. 333MHz is recommended.\r
-#endif\r
-\r
 @@0. "[Display options]"\r
 Enters Display options menu (see below).\r
 \r
@@ -291,11 +208,6 @@ performance hit, but eliminates the tearing effect.
 F100/F200 only: Alters image gamma through GP2X hardware. Larger values make\r
 image to look brighter, lower - darker (default is 1.0).\r
 \r
-@@1. "A_SN's gamma curve"\r
-F100/F200 only: If this is enabled, different gamma adjustment method will be\r
-used (suggested by A_SN from gp32x boards). Intended to be used for F100, makes\r
-difference for dark and bright colors.\r
-\r
 @@1. "Vsync"\r
 This one adjusts the LCD refresh rate to better match game's refresh rate and\r
 starts synchronizing rendering with it. Should make scrolling smoother and\r
@@ -394,13 +306,8 @@ Here you can enable 64K RAM cart. Format it in BIOS if you do.
 \r
 @@2. "Scale/Rot. fx"\r
 The Sega/Mega CD had scaling/rotation chip, which allows effects similar to\r
-"Mode 7" effects in SNES. Disabling may improve performance but cause graphical\r
-glitches.\r
-\r
-@@2. "Better sync"\r
-This option is similar to "Perfect synchro" in Gens. Some games require it to run,\r
-for example most (all?) Wolfteam games, and some other ones. Don't use it for\r
-games which don't need it, it will just slow them down.\r
+"Mode 7" effects in SNES. On slow systems like GP2X, disabling may improve\r
+performance but cause graphical glitches.\r
 \r
 \r
 32X options\r
@@ -478,18 +385,10 @@ F100/F200: 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
 It also decodes MP3s in Sega/Mega CD mode.\r
 \r
-@@4. "RAM overclock"\r
-This overclocks the GP2X RAM chips for improved performance, but may cause\r
-instability. Keep it enabled if it doesn't cause problems.\r
-\r
-@@4. "MMU hack"\r
-Makes framebuffer bufferable for improved performance. There are no drawbacks\r
-so it should be left enabled.\r
-\r
+#endif\r
 @@4. "SVP dynarec"\r
 This enables dynamic recompilation for SVP chip emulated for Virtua Racing game,\r
 what improves it's emulation performance greatly.\r
-#endif\r
 \r
 \r
 Key configuration\r
@@ -498,14 +397,9 @@ Key configuration
 Select "Configure controls" from the main menu. Then select "Player 1" and you will\r
 see two columns. The left column lists names of Genesis/MD controller buttons, and\r
 the right column your handheld ones, which are assigned.\r
-#ifndef PANDORA\r
-If you bind 2 different buttons to the same action, you will get a combo\r
-(which means that you will have to press both buttons for that action to happen).\r
-#endif\r
 \r
 There is also option to enable 6 button pad (will allow you to configure XYZ\r
 buttons), and an option to set turbo rate (in Hz) for turbo buttons.\r
-#ifndef UIQ\r
 \r
 \r
 Cheat support\r
@@ -544,7 +438,6 @@ PATCH FILE: Sonic 2.bin.pat
 \r
 Put the file into your ROMs directory. Then load the .pat file as you would\r
 a ROM. Then Cheat Menu Option should appear in main menu.\r
-#endif\r
 \r
 \r
 What is emulated?\r
@@ -607,7 +500,6 @@ fDave
 one who started it all:\r
 Cyclone 68000 core and PicoDrive itself\r
 \r
-#ifdef PSP\r
 Chui\r
 FAME/C 68k interpreter core\r
 (based on C68K by Stephane Dallongeville)\r
@@ -615,12 +507,10 @@ FAME/C 68k interpreter core
 Stephane Dallongeville (written), NJ (optimized)\r
 CZ80 Z80 interpreter core\r
 \r
-#else\r
 Reesy & FluBBa\r
 DrZ80, the Z80 interpreter written in ARM assembly.\r
 Homepage: http://reesy.gp32x.de/\r
 \r
-#endif\r
 Tatsuyuki Satoh, Jarek Burczynski, MAME development\r
 software implementation of Yamaha FM sound generator\r
 \r
@@ -635,10 +525,6 @@ Gens, MD/Mega CD/32X emulator. Most Sega CD code is based on this emu.
 people @ ps2dev.org forums / PSPSDK crew\r
 libaudiocodec code (by cooleyes)\r
 other sample code\r
-#else\r
-\r
-Helix community\r
-Helix mp3 decoder\r
 #endif\r
 \r
 \r
@@ -653,6 +539,7 @@ Additional thanks
 * Haze for his research (http://haze.mameworld.info).\r
 * Lordus, Exophase and Rokas for various ideas.\r
 * Nemesis for his YM2612 research.\r
+* Eke\r
 * Many posters at spritesmind.net forums for valuable information.\r
 * Mark and Jean-loup for zlib library.\r
 * ketchupgun for the skin.\r
@@ -669,21 +556,25 @@ Additional thanks
 * Kingcdr's for the SDK and Reesy for the DLL and sound code.\r
 * jens.l for supplying the Gizmondo hardware and making this port possible.\r
 #endif\r
-#ifdef UIQ\r
-* Peter van Sebille for his various open-source Symbian projects to learn from.\r
-* Steve Fischer for his open-source Motorola projects.\r
-* The development team behind "Symbian GCC Improvement Project"\r
-  (http://www.inf.u-szeged.hu/symbian-gcc/) for their updated pre-SymbianOS9\r
-  compile tools.\r
-* AnotherGuest for all his Symbian stuff and support.\r
-#endif\r
 * Inder for some graphics.\r
 * Anyone else I forgot. You know who you are.\r
 \r
 \r
 Changelog\r
 ---------\r
-1.80\r
+1.85 (2013-08-31)\r
+  * Lots of 32X compatibility and accuracy improvements. All commercial games\r
+    are booting now, but some still have issues.\r
+  * Fixed some regressions in MegaCD code, like hang in jap BIOS.\r
+  * Implemented pause for SMS.\r
+  * Updated UI with improvements from PCSX ReARMed.\r
+  * Frontend timing has been rewritten, should no longer slowly desync from\r
+    LCD on pandora.\r
+  * Added libretro and SDL 32/64bit ports, fixed compatibility issues with\r
+    Android, iOS.\r
+  * Various other things I forgot (it has been a while since last release..)\r
+\r
+1.80 (2010-09-19)\r
   + Added Caanoo support. Now the GP2X binary supports GP2X F100/F200, Wiz\r
     and Caanoo. Lots of internal refactoring to support this.\r
   + Enabled 32X and SMS code. It's still unfinished but better release something\r
@@ -700,7 +591,7 @@ Changelog
 1.80beta2\r
   * Pandora: updated documentation.\r
 \r
-1.80beta1\r
+1.80beta1 (2010-06-02)\r
   + Added pandora port.\r
   * Internal refactoring for 32x/SMS support.\r
   * Move mapper database to external file.\r
@@ -709,7 +600,7 @@ Changelog
   + ARM: Added new SH2 recompiler for 32x. Some unification with SVP one.\r
   - Disabled most of the above bacause I'm not yet happy with the results.\r
 \r
-1.56\r
+1.56 (2009-09-19)\r
   * Changed sync in Sega CD emulation again. Should fix games that\r
     broke after changes in 1.51a.\r
   * Fixed default keys rebinding when they shouldn't.\r
@@ -954,7 +845,7 @@ Changelog
   + GP2X: Added experimental Sega CD support.\r
   + GP2X: Added partial gmv movie playback support.\r
 \r
-0.964\r
+0.964 (2006-12-03)\r
   * GP2X: Fixed a sound buffer underflow issue on lower sample rate modes, which was\r
           happening for NTSC games and causing sound clicks.\r
   * GP2X: Redone key config to better support USB joysticks (now multiple joysticks\r
@@ -1135,24 +1026,44 @@ Changelog
     not from hardcoded paths.\r
   * Improved 'pause on call' feature, should hopefully work with Motorola phones.\r
 \r
-0.30\r
+0.30 (2006-01-07)\r
   Initial release.\r
 \r
 \r
-Disclaimer\r
-----------\r
-\r
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" \r
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE \r
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE \r
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE \r
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR \r
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF \r
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS \r
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN \r
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) \r
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE \r
-POSSIBILITY OF SUCH DAMAGE. \r
+License\r
+-------\r
+\r
+This program and it's code is released under the terms of MAME license:\r
+\r
+ Redistribution and use of this code or any derivative works are permitted\r
+ provided that the following conditions are met:\r
+\r
+ * Redistributions may not be sold, nor may they be used in a commercial\r
+ product or activity.\r
+\r
+ * Redistributions that are modified from the original source must include the\r
+ complete source code, including the source code for all components used by a\r
+ binary built from the modified sources. However, as a special exception, the\r
+ source code distributed need not include anything that is normally distributed\r
+ (in either source or binary form) with the major components (compiler, kernel,\r
+ and so on) of the operating system on which the executable runs, unless that\r
+ component itself accompanies the executable.\r
+\r
+ * Redistributions must reproduce the above copyright notice, this list of\r
+ conditions and the following disclaimer in the documentation and/or other\r
+ materials provided with the distribution.\r
+\r
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"\r
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
+ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE\r
+ LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
+ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
+ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
+ POSSIBILITY OF SUCH DAMAGE.\r
 \r
 SEGA/Genesis/MegaDrive/SEGA-CD/Mega-CD/32X are trademarks of\r
 Sega Enterprises Ltd.\r