04901a035e8f9778febd8d926449382631705e9a
[gpsp.git] / gp2x / readme_gp2x.txt
1 -- gameplaySP2X  Gameboy Advance emulator for GP2X --\r
2 \r
3 gpSP2X is a version of my (Exophase)'s emulator originally for Sony PSP.\r
4 A large amount of effort has been done to make it more optimized for the\r
5 ARM CPU present in the GP2X, however it is still very much a work in\r
6 progress.\r
7 \r
8 See readme.txt for the PSP version readme, which contains a lot of\r
9 information relevant to the GP2X version (note that some of it does\r
10 not apply however).\r
11 \r
12 \r
13 Changelog:\r
14 \r
15 0.9-2xb u4 (unofficial notaz release, done on Exophase's request)\r
16 - Wiz port. No emulation related changes.\r
17 - Wiz: dropped SDL for video and hitting hardware directly (GPH SDL can't\r
18   be trusted, it doesn't do double buffering as of firmware 1.0).\r
19 - Added new optimized software scaler with interpolation.\r
20 - gpSP is now saving ROM dir on exit. Delete romdir.txt if you don't\r
21   want that.\r
22 - gpSP now comes with wARM, new kernel module+lib for ARM cache control\r
23   (replaces mmuhack).\r
24 - gpSP no longer invalidates whole icache after recompilation, might\r
25   case minor speedup.\r
26 \r
27 0.9-2xb u3 (unofficial notaz release, released with permission):\r
28 - Removed built-in CPU/LCD/RAM-Tweaker.\r
29 - Improved usability of volume control.\r
30 - Removed PSP-specific GUI options, adjusted help text.\r
31 - Overclocking from menu now works, keep it at 200 if you don't want that\r
32   (if you want to overclock using launcher, for example).\r
33 - Fixed centering-on-first-run problem.\r
34 - 3:2 scaled option now does what it says.\r
35 \r
36 0.9-2xb u2 (unofficial notaz release):\r
37 - Replaced non-working mmuhack.o with proper one, added cache flush calls\r
38   to avoid artifacts.\r
39 \r
40 0.9-2xb u1 (unofficial notaz release):\r
41 - Fixed a problen in thread synchronization which caused deadlock after\r
42   some time.\r
43 \r
44 0.9-2xb: \r
45 -- IMPORTANT-- If you're overwriting an old version, be sure to delete the\r
46    gpsp.cfg file first, or be prepared to have a bunch of weird button\r
47    settings that would require fixing.\r
48 \r
49 - Fixed some bugs stunting compatability.\r
50 - Optimized alpha blends in renderer.\r
51 - Some more optimizations to dynarec output.\r
52 - Savestates should work better now.\r
53 - Cheat/misc menu won't crash the emulator.\r
54 - Main button config window works (not all buttons are in yet)\r
55 \r
56 0.9-2Xa: (Exophase release)\r
57 - Redid autoframeskip. Should work more reliably.\r
58 - Rewrote dynamic recompiler from x86 source (arm_emit.h, arm_stub.S).\r
59   Has some more sophisticated behavior than the last version, more is\r
60   still to come... Should notice a slight speed improvement over the\r
61   last version.\r
62 - Tweaked GUI to be a little more useable. Buttons are now mirroring the\r
63   PSP version's.\r
64 - Code unification + cleanup amongst versions.\r
65 \r
66 \r
67 v9008: (zodttd release)\r
68 - Updated the way autoframeskip works. Should be better now. Still has a max\r
69   frameskip value.\r
70 - Added a slight performance increase to the dynarec.\r
71 - Added sync() to make sure files such as savestates and in-game saves are\r
72   saved properly to the GP2X.\r
73 \r
74 v9006: (zodttd release)\r
75 - Initial public release\r
76 \r
77 \r
78 Installation:\r
79 \r
80 1. Place the "gpsp.gpe" and "game_config.txt" file in a directory on your SD\r
81    card used with the GP2X.\r
82 \r
83 2. Place your GBA BIOS in the directory from step 1. This file must be named\r
84    "gba_bios.bin" in all lowercase as shown, so rename it if needed.\r
85 \r
86    -- NOTE --\r
87 \r
88    There are two commonly available BIOSes - one is the correct one used in\r
89    production GBA's worldwide and the other is a prototype BIOS. The latter\r
90    will not cause some games to not work correctly or crash. If you attempt\r
91    to use this BIOS you will be presented with a warning before being\r
92    allowed to continue. This screen will give you a checksum of the real\r
93    BIOS image (see readme.txt for further information).\r
94 \r
95 3. Place your GBA games in the directory from step 1. These files should have\r
96    a ".gba" or ".bin" file extension. Zip compressed games should be supported\r
97    and are recognized with the ".zip" file extension. Note that 32MB ROMs will\r
98    probably not run if zipped. 16MB and smaller should be OK.\r
99 \r
100 4. Done. Run gpsp.gpe.\r
101 \r
102 \r
103 Controls:\r
104 \r
105 How to use gpSP on the GP2X:\r
106 Buttons are mapped as follows (GBA/ingame buttons can be changed in the menu):\r
107 \r
108 GP2X--------------------GBA\r
109 X           ->          A\r
110 B           ->          B\r
111 L TRIG      ->          L TRIG\r
112 R TRIG      ->          R TRIG\r
113 START       ->          START\r
114 SELECT      ->          SELECT\r
115 \r
116 GP2X--------------------------------gpSP\r
117 \r
118 -- IN-GAME --\r
119 \r
120 VOL MIDDLE (UP + DOWN)    ->        menu\r
121 PUSH STICK                ->        fps display toggle (second number is\r
122                                      frames actually drawn)\r
123 \r
124 -- IN-MENU --\r
125 B                         ->        select option\r
126 X                         ->        cancel/exit menu\r
127 A                         ->        escape (up one director level in the\r
128                                      file selector)\r
129 \r
130 When gpSP is started, you are presented with the option to overclock your\r
131 GP2X. Use the L/R TRIG to change the CPU clockspeed and press START to\r
132 continue. You may also change RAM timings here - experiment with what\r
133 works well. Note that going too high on overclocking or low on RAM\r
134 timings can cause the game to crash or the GP2X to outright freeze up.\r
135 \r
136 If you do not want to overclock, press START without using L/R.\r
137 You will now be presented with a menu to choose a game. Press the IN-MENU\r
138 "SELECT" button shown above to pick a game to load.\r
139 \r
140 If you would like to test gpSP for the GP2X with a homebrew (free public\r
141 domain) game, a game by Russ Prince works very well with gpSP. It is called\r
142 Bust-A-Move and is a remake of the classic game it's named after.\r
143 \r
144 \r
145 How to build from source:\r
146 \r
147 The makefile included in the source is geared towards the Open2x toolchain.\r
148 If you use Open2x and installed it in the way recommended then it should\r
149 work okay, assuming you also have up to date HW-SDL (and have\r
150 arm-linux-sdl-config installed in the right place). The makefile is in the\r
151 gp2x directory, so go there first then just type make to build gpsp.gpe.\r
152 Might need a little tweaking if your setup is different. If you need help\r
153 you can ask me, but I'll probably nag you about why you want to build it in\r
154 the first place.\r
155 \r
156 \r
157 GP2X version FAQ:\r
158 \r
159 Q) Help! This game doesn't work. Am I using a bad version of the ROM?\r
160 \r
161 A) First, make sure you're using the correct BIOS version. If you aren't\r
162    gpSP should tell you. Other than that, there are some games that are\r
163    known to not work now (and will probably work later), and perhaps\r
164    many more games that I don't know about that don't work. I haven't\r
165    launched a full scale compatability test at this version, so it might\r
166    take a while before the compatability levels are high.\r
167 \r
168 \r
169 Q) Why is this version slower than the PSP version?\r
170 \r
171 A) gpSP is still a work in progress. It might be possible to obtain more\r
172    speed from both this version and the PSP one too (and others in the\r
173    future). With that in mind, know that even a very agressively overclocked\r
174    GP2X is still less powerful than a PSP, generally speaking. Still, I\r
175    have a lot of ideas. It's unlikely that the GP2X version will ever be as\r
176    fast/faster than the PSP version for anyone but anything's possible.\r
177 \r
178 \r
179 Q) How high does my GP2X have to overclock to enjoy gpSP?\r
180 \r
181 A) That depends on you. Higher overclocking will mean less frames skipped\r
182    on autoframeskip, or less frameskip needed if on manual. Or it can\r
183    make the difference between whether or not virtual 60fps can be reached.\r
184    For some games no GP2X in the world will be able to run them fullspeed,\r
185    with any amount of frameskip. A few might run well with no overclocking\r
186    and a generous level of frameskip (probably manual). If you don't care\r
187    about battery life (or you're plugged into an outlet) you should push\r
188    it as high as you can while still maintaining stability, because\r
189    chances are high that whatever you play will benefit from it. Right now\r
190    you'll probably want 260MHz if you can achieve it, but with a lot of\r
191    luck this number will lower slightly in the future (and is just a vague\r
192    ballpark figure anyway). I don't want to scare anyone off from using the\r
193    emulator, you should give it a try and see how it plays for you\r
194    regardless of how high you can overclock. Just note that this is far\r
195    from a locked smooth experience for everyone on every game.\r
196 \r
197 \r
198 Q) GBA has an ARM processor, GP2X has an ARM processor. GP2X is more\r
199    powerful than GBA. This emulator should run great without overclocking,\r
200    so therefore you're doing it wrong.\r
201 \r
202 A) That's not a question, but I'll field it anyway. Two things: first,\r
203    "virtualization", or running the GBA code "natively" on the GP2X is\r
204    probably not possible, at least not with the way I want to do things.\r
205    For reasons why go read my blog (see below). So yes, you actually\r
206    do need more than 16.7MHz of ARM9 power to emulate the GBA's CPU.\r
207    Second: there is a whole lot of work behind emulating the pretty 2D\r
208    graphics on the GBA, something it can do in hardware a lot better than\r
209    this platform can.\r
210    End result: GBA emulation on GP2X isn't as easy as you think it is.\r
211 \r
212 \r
213 Q) What are you working on now? When will you release the next version?\r
214 \r
215 A) See the gpSP development blog:\r
216 \r
217    http://gpsp-dev.blogspot.com/\r
218 \r
219    Note that I don't give release dates, ever, unless I'm right on the verge\r
220    of releasing. Be grateful that I've decided to be much more open about\r
221    the development of the emulator now.\r
222 \r
223 \r
224 Q) Thanks to your blog I heard that you made some improvement. Can I have\r
225    a copy of the new code?\r
226 \r
227 A) No. Builds in transition often have a lot of problems, and I like for\r
228    releases to be relatively substantial. I can probably be bribed out of\r
229    them with donations though. :P\r
230 \r
231 \r
232 Q) Why do the menu suck so much? Why do half the options not work or not\r
233    make any sense?\r
234 \r
235 A) Sorry, the menu still hasn't been modified very much to fit the GP2X\r
236    version instead of the PSP version.. hopefully this will improve in the\r
237    future.\r
238 \r
239 \r
240 Q) Who's in charge of the GP2X version anyway?\r
241 \r
242 A) Originally, zodttd was. I, Exophase, have basically usurped control of it\r
243    now to encourage zodttd to work more on his PS1 emulator (that and I'm\r
244    possessive of gpSP and get nervous when people work on it too heavily).\r
245    zodttd will most likely still be around to work on things though.\r
246 \r
247 \r
248 Q) I'm a super nice person and would like to donate some of my hard earned\r
249    money to this one-off GBA emulator. Where do I send my money to?\r
250 \r
251 A) Exophase: exophase@gmail.com on PayPal\r
252    zodttd: https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&business=heirloomer\r
253     %40pobox%2ecom&item_number=1&no_shipping=1&no_note=1&tax=0&cy_code=USD&bn=\r
254     PP%2dDonationsBF&charset=UTF%2d8\r
255     ^ Click there for donating on PayPal (remove whitespace/linebreaks).\r
256 \r
257    GP2X people have already donated a lot more to me than PSP people have,\r
258    even though there's an order of magnitude or two less users. And they've\r
259    donated far more to zodttd than they have to me. So I'm not going to ask\r
260    people to donate..\r
261 \r
262    However I won't lie: donating ups the chances of me actually working on the\r
263    next version (for which I have a lot of ideas, but not necessarily time to\r
264    dedicate to.. that time might need more incentive to be allotted from other\r
265    things). This could change depending on my employment situation, but right\r
266    now I feel guilty doing anything that doesn't help guarantee that I'll be\r
267    able to buy food a year from now.\r
268 \r
269 \r
270 Q) Tell me all of your personal information.\r
271 \r
272 A) Again not a question, but why not. I'm Exophase, real name: Gilead Kutnick,\r
273    male, 23 years old, current residence Bloomington, IN; straight/single/not\r
274    actively looking, almost have an MS in Computer Science (do have a BS\r
275    underneath it), likes PSP more than GP2X, will not write a Nintendo DS\r
276    emulator for either, am currently looking for a job for after I graduate.\r
277 \r
278 \r
279 Q) You said you're looking for a job.\r
280 \r
281 A) Yes. If you have one or know someone who needs a low level oriented\r
282    programmer then I'm up for grabs. And this is my resume:\r
283    http://exophase.devzero.co.uk/resume.pdf\r
284 \r
285 \r
286 Credits:\r
287 \r
288 Original codebase: Exophase (exophase@gmail.com)\r
289 Foundation gp2x code: zodttd\r
290 GP2X dynarec/stubs + current code maintainance: Exophase\r
291 \r