readme and textfilter updated for uiq3
[libpicofe.git] / base_readme.txt
index 40a6a77..c0969bf 100644 (file)
@@ -36,7 +36,6 @@ How to make it run
 Copy PicoDrive.gpe, pico940_v3.bin and mmuhack.o to any place in your filesystem\r
 (all 3 files must be in the same directory) and run PicoDrive.gpe.\r
 Then load a ROM and enjoy! ROMs can be in .smd or .bin format and can be zipped.\r
-\r
 #endif\r
 #ifdef GIZ\r
 First make sure you have homebrew-enabled Service Pack installed. Then copy\r
@@ -45,7 +44,6 @@ be in the same directory) and run PicoDrive.exe using the launcher of your choic
 (some of them might require renaming PicoDrive.exe to Autorun.exe, placing it in\r
 the root of SD, etc). Then load a ROM and enjoy! ROMs can be placed anywhere, can\r
 be in .smd or .bin format and can be zipped (one ROM per zip).\r
-\r
 #endif\r
 #ifdef PSP\r
 If you are running a custom firmware, just copy the whole PicoDrive directory to\r
@@ -53,8 +51,13 @@ If you are running a custom firmware, just copy the whole PicoDrive directory to
 which one GAME* directory to use).\r
 \r
 If you are on 1.5, there is a separate KXploited version for it.\r
-\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
+#ifndef UIQ\r
+\r
 Note that this emulator may require some tweaking of configuration settings to run\r
 some games well. For Genesis/MegaDrive, if you have any problems (game does not\r
 boot, sound is glitchy, broken graphics), try to:\r
@@ -67,20 +70,26 @@ boot, sound is glitchy, broken graphics), try to:
 Some games may need to be reset after adjusting settings.\r
 \r
 For possible Sega/Mega CD problems, see "Other important stuff" section below.\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 the same\r
-directory as mentioned PicoDrive files. Files can be named as follows:\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
+the same directory as mentioned PicoDrive files.\r
+#endif\r
+Files can be named as follows:\r
 \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 CUE/BIN can be used too. When using\r
+The game must be dumped to ISO/MP3, CUE/CSO/MP3 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
@@ -100,6 +109,9 @@ Sonic the Hedgehog CD (US) - Track 02.mp3
 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
@@ -122,7 +134,11 @@ Other important stuff
 ---------------------\r
 \r
 * If your Genesis/MD game has graphical glitches, this is most likely because\r
+#ifndef UIQ\r
   "accurate renderer" is not enabled (see options).\r
+#else\r
+  "Fast renderer (inaccurate)" is enabled. Try disabling it.\r
+#endif\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
@@ -164,6 +180,9 @@ Other important stuff
 Configuration\r
 -------------\r
 \r
+#ifdef UIQ\r
+#include "config.txt"\r
+#else\r
 @@0. "Renderer"\r
 #ifdef GP2X\r
 8bit fast:\r
@@ -242,10 +261,6 @@ 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
 #endif\r
 \r
-@@0. "6 button pad"\r
-If you enable this, games will think that 6 button gamepad is connected. If you\r
-go and reconfigure your keys, you will be able to bind X,Y,Z and mode actions.\r
-\r
 @@0. "Region"\r
 This option lets you force the game to think it is running on machine from the\r
 specified region, or just to set autodetection order. Also affects Sega/Mega CD.\r
@@ -370,6 +385,10 @@ Well known way to improve the GP2X performance. You must restart the emulator
 for the change of this option to take effect.\r
 \r
 #endif\r
+@@1. "Disable idle loop patching"\r
+Idle loop patching is used to improve performance, but may cause compatibility\r
+problems in some rare cases. Try disabling this if your game has problems.\r
+\r
 \r
 Sega/Mega CD options \r
 --------------------\r
@@ -450,6 +469,9 @@ There are 3 options:
 @@3. "Set to unscaled centered"\r
 Adjust the resizing options to set game image to it's original size.\r
 \r
+@@3. "Set to 4:3 scaled"\r
+Scale the image up, but keep 4:3 aspect, by adding black borders.\r
+\r
 @@3. "Set to fullscreen"\r
 Adjust the resizing options to make the game image fullscreen.\r
 \r
@@ -470,7 +492,11 @@ the right Giz ones, which are assigned to them. If you bind 2 different Giz butt
 the right PSP ones, which are assigned to them. If you bind 2 different PSP buttons\r
 #endif\r
 to the same action, you will get a combo (which means that you will have to press\r
-both buttons for that action to happen.\r
+both buttons for that action to happen).\r
+\r
+There is also option to enable 6 button pad (will allow you to configure XYZ\r
+keys), and an option to set turbo rate (in Hz) for turbo buttons.\r
+#endif\r
 \r
 \r
 Cheat support\r
@@ -643,12 +669,24 @@ Additional thanks
 \r
 Changelog\r
 ---------\r
-1.50a\r
+1.51b\r
+  * Fixed a crash when uncompressed savestate is loaded.\r
+  * Fixed an idle loop detection related hanging problem.\r
+  * PSP: fixed another palette related regression.\r
+  * UIQ3: updated frontend for the latest emu core.\r
+\r
+1.51a\r
+  * Fixed a sync problem between main and sub 68k. Should fix the hanging\r
+    problem for some games.\r
+  * ARM: fixed a crash when CD savestate is loaded just after loading ROM.\r
+\r
+1.51\r
   * Improved bin_to_cso_mp3 tool, it should no longer complain about\r
     missing lame.exe even if it's in working dir.\r
   * Fixed a regression from 1.50, which caused slowdowns in Final Fight.\r
   * Fixed some regressions from 1.50 related to sprite limit and palette\r
     handling (caused graphical glitches in some games).\r
+  + Added ABC turbo actions to key config.\r
   * Some other minor adjustments.\r
 \r
 1.50\r