out_gp2x/readme.txt

   1 =================================================================================\r
   2                      GPFCE - NES emulator for the GP2X\r
   3 =================================================================================\r
   4 \r
   5 \r
   6 This is a gp2x port of the **great** Open Source NES emulator FCE Ultra:\r
   7 http://fceultra.sourceforge.net.   If you enjoyed using this emulator, please\r
   8 keep in mind that this would not have been possible without the hard work and\r
   9 dedication of the FCE Ultra developers.\r
  10 \r
  11 In case you don't know what the NES is about, see:\r
  12 http://en.wikipedia.org/wiki/Famicom.\r
  13 \r
  14 \r
  15 ------------------------------------------------------------------\r
  16  Usage\r
  17 ------------------------------------------------------------------\r
  18 \r
  19 1)  Unzip the emulator onto some directory on your SD card.\r
  20 2)  Since version 0.4 ROMs no longer have to be put to fixed location,\r
  21     so you can put them anywhere. Rom files can be zipped.\r
  22 3)  The emulator will create a subdirectory in it's working directory \r
  23     called fceultra. Save states etc. go here.\r
  24     If you want to load saves from < 0.4 version, you should copy files\r
  25     from /mnt/sd/roms/nes/fceultra/fcs to\r
  26     <where_you_put_gpfce>/fceultra/fcs directory.\r
  27 4)  Hit both volume keys to enter the menu.\r
  28 5)  For FDS support, put disksys.rom in <where_you_put_gpfce>/fceultra\r
  29 6)  For GameGenie support, put gg.rom in <where_you_put_gpfce>/fceultra\r
  30 \r
  31 \r
  32 ------------------------------------------------------------------\r
  33  Controls\r
  34 ------------------------------------------------------------------\r
  35 \r
  36 Since v0.4 controls are configurable. Default controls are:\r
  37 \r
  38 B         - NES A\r
  39 X         - NES B\r
  40 Y         - NES A (turbo)\r
  41 A         - NES B (turbo)\r
  42 SELECT    - NES SELECT\r
  43 START     - NES START\r
  44 VOL +/-   - Vol control. Pressing both enters the menu. \r
  45 \r
  46 L & JOY   - Save state\r
  47 R & JOY   - Load State\r
  48 \r
  49 Note: JOY means press in on the joystick (i.e. not up/down/left/right)\r
  50 \r
  51 \r
  52 gpfce can't emulate all input devices which FCE Ultra does, but it can handle\r
  53 gamepad emulation of course, plus it can emulate Zapper and the Arkanoid\r
  54 controller (the last two have hardcoded controls).\r
  55 \r
  56 B is the emulated trigger button for the Zapper. X is also emulated as the\r
  57 trigger, but as long as you have it pressed down, no color detection will take\r
  58 place, which is effectively like pulling the trigger while the Zapper is\r
  59 pointed away from the television screen. Note that you must press X for a\r
  60 short time to have the desired effect.\r
  61 \r
  62 For Zapper and the Arkanoid controller Y increases the movement speed,\r
  63 A decreases.\r
  64 \r
  65 \r
  66 ------------------------------------------------------------------\r
  67  Palettes\r
  68 ------------------------------------------------------------------\r
  69 \r
  70 gpfce has similar palette options as FCE Ultra, so here is modified excerpt\r
  71 from FCE Ultra manual:\r
  72 \r
  73 FCE Ultra has many palette features, including loading a custom palette to\r
  74 replace the default NES palette (see FCE Ultra option in options menu).\r
  75 The palette from an NTSC NES can also be generated on-the-fly.\r
  76 \r
  77 First, a note on on the format of external palettes; Palette files are expected\r
  78 to contain 64 8-bit RGB triplets(each in that order; red comes first in the\r
  79 triplet in the file, then green, then blue). Each 8-bit value represents\r
  80 brightness for that particular color. 0 is minimum, 255 is maximum.\r
  81 \r
  82 Palettes can be set on a per-game basis. To do this, put a palette file in the\r
  83 <where_you_put_gpfce>/fceultra/pal directory with the same base filename as the\r
  84 game you wish to associate with and add the extension "pal". Examples:\r
  85 \r
  86                 File name:              Palette file name:\r
  87                  BigBad.nes              BigBad.pal\r
  88                  BigBad.zip              BigBad.pal\r
  89                  BigBad.Better.nes       BigBad.Better.pal\r
  90 \r
  91 \r
  92 With so many ways to choose a palette, figuring out which one will be active may\r
  93 be difficult. Here's a list of what palettes will be used, in order from highest\r
  94 priority to least priority(if a condition doesn't exist for a higher priority\r
  95 palette, the emulator will continue down its list of palettes).\r
  96 \r
  97     * Palette loaded from the "fceultra/pal" directory.\r
  98     * NTSC Color Emulation(only for NTSC NES games).\r
  99     * VS Unisystem palette(if the game is a VS Unisystem game and a palette is available).\r
 100     * Custom global palette (set in the menu).\r
 101     * Default NES palette.\r
 102 \r
 103 \r
 104 ------------------------------------------------------------------\r
 105  Famicom Disk System\r
 106 ------------------------------------------------------------------\r
 107 \r
 108 You will need the FDS BIOS ROM image in <where_you_put_gpfce>/fceultra directory.\r
 109 It's size should be 8192 bytes and it must be named "disksys.rom".\r
 110 gpfce will not load FDS games without this file.\r
 111 \r
 112 You will also probably need configure keys for swapping the virtual FDS disks,\r
 113 they are configurable in Controls menu.\r
 114 \r
 115 Two types of FDS disk images are supported: disk images with the FWNES-style header,\r
 116 and disk images with no header. The number of sides on headerless disk images is\r
 117 calculated by the total file size, so don't put extraneous data at the end of the file.\r
 118 \r
 119 \r
 120 ------------------------------------------------------------------\r
 121  VS Unisystem\r
 122 ------------------------------------------------------------------\r
 123 \r
 124 gpfce currently only supports VS Unisystem ROM images in the iNES format. See\r
 125 FCE Ultra manual for the list of supported games.\r
 126 \r
 127 You will need to configure a key to insert coins, see Controls option in the menu.\r
 128 \r
 129 \r
 130 ------------------------------------------------------------------\r
 131  Cheats\r
 132 ------------------------------------------------------------------\r
 133 \r
 134 For cheating you can ether use the authentic game genie support, or the .cht files.\r
 135 \r
 136 To use authentic game genie, place appropriate gg.rom into\r
 137 <where_you_put_gpfce>/fceultra.\r
 138 Use the FCE Ultra option menu or -gg on commandline to activate the game genie rom.\r
 139 The ROM image may either be the 24592 byte iNES-format image, or the 4352\r
 140 byte raw ROM image.\r
 141 \r
 142 The .cht files fould be placed into <where_you_put_gpfce>/fceultra/cheats/ directory.\r
 143 They should have the same base filename as the game you wish to associate with\r
 144 with the extension "cht". Examples:\r
 145 \r
 146                 File name:              Palette file name:\r
 147                  BigBad.nes              BigBad.cht\r
 148                  BigBad.zip              BigBad.cht\r
 149                  BigBad.Better.nes       BigBad.Better.cht\r
 150 \r
 151 If you have done everything correctly, Cheat option will appear in the main menu\r
 152 after you load the ROM. You can activate/deactivate cheats by pressing B.\r
 153 For description of .cht file format, see http://fceultra.sourceforge.net/cheat.php\r
 154 \r
 155 \r
 156 ------------------------------------------------------------------\r
 157  IPS patch support\r
 158 ------------------------------------------------------------------\r
 159 \r
 160 Place the IPS files in the same directory as the ROM to load, and name them\r
 161 filename.ips or filename.something.ips. Examples:\r
 162 \r
 163 \r
 164          File name:              IPS file names:\r
 165           BigBad.nes              BigBad.nes.ips           BigBad.nes.somehack.ips\r
 166           BigBad.zip              BigBad.zip.ips           BigBad.zip.badhack.ips\r
 167           BigBad.Better.nes       BigBad.Better.nes.ips    BigBad.Better.nes.evenbetterhack.ips\r
 168 \r
 169 Patching is supported for all supported formats (iNES, FDS, UNIF, and NSF), but\r
 170 it will probably only be useful for the iNES and FDS formats. UNIF files can't be\r
 171 patched well with the IPS format because they are chunk-based with no fixed offsets.\r
 172 \r
 173 \r
 174 ------------------------------------------------------------------\r
 175  FCM movies\r
 176 ------------------------------------------------------------------\r
 177 \r
 178 Version 0.4 has partial FCM movie support. Most of the movies desync due to\r
 179 different timing, but some of them can be played. Note that 'accurate renderer'\r
 180 option solves some desync problems. There is only playback support.\r
 181 Files should be placed in the ROMs directory along with the ROMs themselves.\r
 182 Naming is the same as for IPS patches (see previous section), buf use .fcm\r
 183 extension instead of .ips.\r
 184 \r
 185 \r
 186 --------------------------------------------------------------------\r
 187  Version History\r
 188 --------------------------------------------------------------------\r
 189 \r
 190 \r
 191 ver 0.4 (by notaz)\r
 192   rev 171\r
 193           - Added optional "Accurate renderer", which is the original FCE Ultra\r
 194             0.98.x renderer + PPU emulation code. It's much slower, but it can\r
 195             handle games which need more precise PPU timing emulation (like\r
 196             Marble Madness).\r
 197           - Fixed saving and loading of game specific configs.\r
 198           - Some other minor changes.\r
 199   rev 163\r
 200           - Added A r k's fast-direction-change fix for usbjoy lib.\r
 201           - Fixed an issue of usbjoys stopping to work when "Perfect vsync"\r
 202             is enabled.\r
 203   rev 162\r
 204           - Fixed savestate subsections (were causing some mapper data not\r
 205             to be saved).\r
 206           - Fixed an issue of MapIRQHook getting lost after loading a savestate\r
 207             (glitched Akumajou Densetsu and other games after savestate load).\r
 208           - A bug, which prevented configuring multiple USB pads fixed.\r
 209           - Fixed sound breaking bug after switching it on/off multiple times.\r
 210           - Added "Perfect VSYNC" option, which changes GP2X refresh rate and\r
 211             syncs emu timing to LCD vsync.\r
 212           - Fixed IPS patch support.\r
 213   rev 153\r
 214           - Lots of work on the asm core. Timing fixed for some instructions.\r
 215             Some missing undocumented instruction handlers added. Lots of\r
 216             tweaking to make it compatible with all that mapper code.\r
 217           - Completely new PicoDrive style menu added with most standard\r
 218             FCE Ultra and some additional options. Selector removed, ROM list\r
 219             is now built-in and only limited by available memory.\r
 220           - Merged in most of code from 0.98.1x versions. Only ppu/rendering\r
 221             and sound emulation code left from 0.81 (which is less accurate\r
 222             but much faster).\r
 223           - Default palette changed to one from later versions.\r
 224           - Fixed some alignment problems in MMC5 and some other mappers.\r
 225           - Some generic optimizations and code cleanup/refactoring.\r
 226           - The built-in NSF player fixed.\r
 227           - Authentic GameGenie support fixed.\r
 228           - FDS support fixed.\r
 229           - VS Unisystem support fixed.\r
 230           - Ingame saves fixed (not sure when they got broken).\r
 231           - Increased maximum sound volume.\r
 232           - Added Zapper emulation just for fun.\r
 233           - Added partial FCM movie support.\r
 234           - Fixed some memory leaks.\r
 235           - Fixed a bug which caused USB connection from GP2X menu\r
 236             to hang after using gpfce.\r
 237           - Software scaler added.\r
 238           - USB gamepad support added.\r
 239           - TV out fixed.\r
 240           - Documentation updated.\r
 241 \r
 242 \r
 243 ver 0.3 (by notaz)\r
 244 \r
 245           - Major improvement: added ARM asm CPU core from LJGP32,\r
 246             which itself was adapted from FCA by Yoyofr.\r
 247             The core required substantial changes to make it work in\r
 248             FCE ultra.\r
 249           - The emulator renders directly to frame buffer now (previously\r
 250             it was drawing to offscreen buffer, which was then copied to\r
 251             framebuffer).\r
 252           - Squidge's MMU hack added.\r
 253           - Added sync() calls after savestate writes.\r
 254           - Some additional tweaking here and there to get a few more FPS.\r
 255           - Volume middle now can be used as shift to emulator functions\r
 256             instead stick click (saving, stretching, etc.).\r
 257           - Added frameskip selection with shift+A and shift+Y (shift is\r
 258             stick click or volume middle).\r
 259           - Probably some more changes I forgot about.\r
 260 \r
 261 \r
 262 \r
 263 ver 0.2   5/29/2006  MD5SUM: dd75fa3f090f9298f9f4afff01ab96f2 *gpfce\r
 264 \r
 265           - Sound output issue with stereo fixed, now using\r
 266             22050 khz 16-bit mono.  I've tried interpolating to \r
 267             44khz mono, but the results seemed similar.\r
 268           - selector supports up to 2048 files, sorted, with\r
 269             alpha scrolling via left/right in addition to \r
 270             page up/down via L/R.\r
 271           - additional startup scripts to select button and fps  \r
 272             configurations\r
 273           - can load FDS files, but does not seem to work yet\r
 274           - configurable buttons  (use swapbuttons version )\r
 275           - configurable fps (use showfps version)\r
 276           - Configurable turbo fire control\r
 277           - Selectable save slots from 0-9\r
 278           - Volume bar\r
 279           - compiled with GCC 4.1.0 -O3 with profiling\r
 280 \r
 281 \r
 282 ver 0.1   5/23/2006  MD5SUM: 13681f25713ad04c535c23f8c61f1e0b *gpfce\r
 283 \r
 284           - Initial version\r
 285           - Around 60 fps with sound\r
 286           - Load/Save State\r
 287           - Hardware Stretch\r
 288           - Soft reset support\r
 289           - No GUI, using selector with config\r
 290           - Hard coded 22050 audio, 16-bit, stereo\r
 291           - compiled with GCC 4.1.0 -O3 with profiling\r
 292           - Hard coded config path.  This is to prevent users\r
 293             from filling up the gp2x space by accident\r
 294 \r
 295 \r
 296       \r
 297 ------------------------------------------------------------------\r
 298  Credits/thanks\r
 299 ------------------------------------------------------------------\r
 300 \r
 301 - Original base code of FCE Ultra by Xodnizel, Bero.\r
 302 - Porting/optimization/integration/frontend for 0.3 and 0.4 by notaz.\r
 303 - Versions 0.1 and 0.2 by zzhu8192 (http://www.unicorn-jockey.com).\r
 304 - asm CPU core from FCA and Little John GP32.\r
 305 - Minimal library by rlyeh.\r
 306 - Additional low-level GP2X libs by Hermes/PS2Reality, theoddbot,\r
 307   god_at_hell, Puck2099.\r
 308 \r
 309 additional thanks:\r
 310 - Cruel and DaveC from gp32x boards for beta testing.\r
 311 - All FCE Ultra contributors listed in\r
 312   http://fceultra.sourceforge.net/docs.php\r
 313 \r
 314 ...and everyone whose name my mind has misplaced.\r
 315 \r
 316 zzhu8192's thanks:\r
 317 - To lots of talented developers on the http://www.gp32x.com/board/\r
 318   Reesy, Squidge, etc.  for responding to my technical questions.\r
 319 - Thanks to \r
 320 - Lil-kun - for the neat GPFCE logo and the Web Site (under construction) :D\r
 321 - Referenced source code from MameGP2X (Franxis) and FCEU-0.3 gp2x (Noname)\r
 322 - Awesome wiki: http://wiki.gp2x.org/wiki/Main_Page\r
 323 - Awesome gp2x site: http://www.gp32x.com/\r
 324 - ryleh's minimal lib - w/o which this wouldn't have worked\r
 325 - FCE Ultra developers (http://fceultra.sourceforge.net/) \r
 326   for the wonderful and feature rich NES emulator.\r
 327 - kounch for Selector frontend - works great for lazy developers like me.  :-D\r
 328   I have sent my changes to kounch, so hopefully the changes will make it into\r
 329   version 1.2 or later.\r
 330 - gp2x community - just plain rocks\r
 331 \r
 332 \r