move some gp2x files
[fceu.git] / drivers / gp2x / out /
1 [About]\r
2 This is a gp2x port of the **great** Open Source NES emulator FCE Ultra:\r
3   If you enjoyed using this emulator, please\r
4 keep in mind that this would not have been possible without the hard work and\r
5 dedication of the FCE Ultra developers.\r
6 \r
7 In case you don't know what the NES is about, see:\r
9 \r
10 \r
11 [Usage]\r
12 1)  Unzip the emulator onto some directory on your SD card.\r
13 2)  Since version 0.4 ROMs no longer have to be put to fixed location, so you can put them anywhere. Rom files can be zipped.\r
14 3)  The emulator will create a subdirectory in it's working directory called fceultra. Save states etc. go here. If you want to load saves from < 0.4 version, you should copy files from /mnt/sd/roms/nes/fceultra/fcs to <where_you_put_gpfce>/fceultra/fcs directory.\r
15 4)  Hit both volume keys to enter the menu.\r
16 5)  For FDS support, put disksys.rom in <where_you_put_gpfce>/fceultra\r
17 6)  For GameGenie support, put gg.rom in <where_you_put_gpfce>/fceultra\r
18 \r
19 \r
20 [Controls]\r
21 Since v0.4 controls are configurable. Default controls are:\r
22 \r
23 B         - NES A\r
24 X         - NES B\r
25 Y         - NES A (turbo)\r
26 A         - NES B (turbo)\r
28 START     - NES START\r
29 VOL +/-   - Vol control. Pressing both enters the menu. \r
30 \r
31 L & JOY   - Save state\r
32 R & JOY   - Load State\r
33 \r
34 Note: JOY means press in on the joystick (i.e. not up/down/left/right)\r
35 \r
36 \r
37 gpfce can't emulate all input devices which FCE Ultra does, but it can handle gamepad emulation of course, plus it can emulate Zapper and the Arkanoid controller (the last two have hardcoded controls).\r
38 \r
39 B is the emulated trigger button for the Zapper. X is also emulated as the trigger, but as long as you have it pressed down, no color detection will take place, which is effectively like pulling the trigger while the Zapper is pointed away from the television screen. Note that you must press X for a short time to have the desired effect.\r
40 \r
41 For Zapper and the Arkanoid controller Y increases the movement speed, A decreases.\r
42 \r
43 \r
44 [Palettes]\r
45 gpfce has similar palette options as FCE Ultra, so here is modified excerpt from FCE Ultra manual:\r
46 \r
47 FCE Ultra has many palette features, including loading a custom palette to replace the default NES palette (see FCE Ultra option in options menu).\r
48 The palette from an NTSC NES can also be generated on-the-fly.\r
49 \r
50 First, a note on on the format of external palettes; Palette files are expected to contain 64 8-bit RGB triplets(each in that order; red comes first in the triplet in the file, then green, then blue). Each 8-bit value represents brightness for that particular color. 0 is minimum, 255 is maximum.\r
51 \r
52 Palettes can be set on a per-game basis. To do this, put a palette file in the <where_you_put_gpfce>/fceultra/pal directory with the same base filename as the game you wish to associate with and add the extension "pal". Examples:\r
53 \r
54   File name:              Palette file name:\r
55    BigBad.nes              BigBad.pal\r
56              BigBad.pal\r
57    BigBad.Better.nes       BigBad.Better.pal\r
58 \r
59 \r
60 With so many ways to choose a palette, figuring out which one will be active may be difficult. Here's a list of what palettes will be used, in order from highest priority to least priority(if a condition doesn't exist for a higher priority palette, the emulator will continue down its list of palettes).\r
61 \r
62     * Palette loaded from the "fceultra/pal" directory.\r
63     * NTSC Color Emulation(only for NTSC NES games).\r
64     * VS Unisystem palette(if the game is a VS Unisystem game and a palette is available).\r
65     * Custom global palette (set in the menu).\r
66     * Default NES palette.\r
67 \r
68 \r
69 [Famicom Disk System]\r
70 You will need the FDS BIOS ROM image in <where_you_put_gpfce>/fceultra directory.\r
71 It's size should be 8192 bytes and it must be named "disksys.rom".\r
72 gpfce will not load FDS games without this file.\r
73 \r
74 You will also probably need configure keys for swapping the virtual FDS disks, they are configurable in Controls menu.\r
75 \r
76 Two types of FDS disk images are supported: disk images with the FWNES-style header, and disk images with no header. The number of sides on headerless disk images is calculated by the total file size, so don't put extraneous data at the end of the file.\r
77 \r
78 \r
79 [VS Unisystem]\r
80 gpfce currently only supports VS Unisystem ROM images in the iNES format. See FCE Ultra manual for the list of supported games.\r
81 \r
82 You will need to configure a key to insert coins, see Controls option in the menu.\r
83 \r
84 \r
85 [Cheats]\r
86 For cheating you can ether use the authentic game genie support, or the .cht files.\r
87 \r
88 To use authentic game genie, place appropriate gg.rom into <where_you_put_gpfce>/fceultra. Use the FCE Ultra option menu or -gg on commandline to activate the game genie rom. The ROM image may either be the 24592 byte iNES-format image, or the 4352 byte raw ROM image.\r
89 \r
90 The .cht files fould be placed into <where_you_put_gpfce>/fceultra/cheats/ directory. They should have the same base filename as the game you wish to associate with with the extension "cht". Examples:\r
91 \r
92   File name:              Palette file name:\r
93    BigBad.nes              BigBad.cht\r
94              BigBad.cht\r
95    BigBad.Better.nes       BigBad.Better.cht\r
96 \r
97 If you have done everything correctly, Cheat option will appear in the main menu after you load the ROM. You can activate/deactivate cheats by pressing B. For description of .cht file format, see\r
98 \r
99 [IPS patch support]\r
100 Place the IPS files in the same directory as the ROMs to load, and name them filename.ips or filename.something.ips. Examples:\r
101 \r
102   File name:              IPS file names:\r
103    BigBad.nes              BigBad.nes.ips           BigBad.nes.somehack.ips\r
104     \r
105    BigBad.Better.nes       BigBad.Better.nes.ips    BigBad.Better.nes.evenbetterhack.ips\r
106 \r
107 Patching is supported for all supported formats (iNES, FDS, UNIF, and NSF), but it will probably only be useful for the iNES and FDS formats. UNIF files can't be patched well with the IPS format because they are chunk-based with no fixed offsets.\r
108 \r
109 \r
110 [FCM movies]\r
111 Version 0.4 has partial FCM movie support. Most of the movies desync due to different timing, but some of them can be played. Note that 'accurate renderer' option solves some desync problems. There is only playback support. Files should be placed in the ROMs directory along with the ROMs themselves. Naming is the same as for IPS patches (see previous section), buf use .fcm extension instead of .ips.\r
112 \r
113 \r
114 [Credits/thanks]\r
115 - Original base code of FCE Ultra by Xodnizel, Bero.\r
116 - Porting/optimization/integration/frontend for 0.3 and 0.4 by notaz.\r
117 - Versions 0.1 and 0.2 by zzhu8192 (\r
118 - asm CPU core from FCA and Little John GP32.\r
119 - Minimal library by rlyeh.\r
120 - Additional low-level GP2X libs by Hermes/PS2Reality, theoddbot,\r
121   god_at_hell, Puck2099.\r
122 \r
123 additional thanks:\r
124 - Cruel and DaveC from gp32x boards for beta testing.\r
125 - All FCE Ultra contributors listed in\r
127 \r
128 ...and everyone whose name my mind has misplaced.\r
129 \r
130 zzhu8192's thanks:\r
131 - To lots of talented developers on the\r
132   Reesy, Squidge, etc.  for responding to my technical questions.\r
133 - Thanks to \r
134 - Lil-kun - for the neat GPFCE logo and the Web Site (under construction) :D\r
135 - Referenced source code from MameGP2X (Franxis) and FCEU-0.3 gp2x (Noname)\r
136 - Awesome wiki:\r
137 - Awesome gp2x site:\r
138 - ryleh's minimal lib - w/o which this wouldn't have worked\r
139 - FCE Ultra developers ( \r
140   for the wonderful and feature rich NES emulator.\r
141 - kounch for Selector frontend - works great for lazy developers like me.  :-D\r
142   I have sent my changes to kounch, so hopefully the changes will make it into\r
143   version 1.2 or later.\r
144 - gp2x community - just plain rocks\r
145 \r
146 \r