add caanoo frontend files, move pandora files
[pcsx_rearmed.git] / readme.txt
1
2 PCSX-ReARMed - yet another PCSX fork
3
4 http://notaz.gp2x.de/pcsx_rearmed.php
5
6
7 About
8 -----
9
10 PCSX ReARMed is yet another PCSX fork based on the PCSX-Reloaded project,
11 which itself contains code from PCSX, PCSX-df and PCSX-Revolution. This
12 version is ARM architecture oriented and features MIPS->ARM recompiler by
13 Ari64, NEON GTE code and more performance improvements. It was created for
14 Pandora handheld, but should be usable on other devices after some code
15 adjustments (N900 version is also available).
16
17 PCSX ReARMed features GPU plugin from PCSX4ALL project.
18
19
20 Usage
21 -----
22
23 This version features a framebuffer driven menu that can be used to run
24 games and configure the emulator.
25
26 Supported CD image formats:
27 - .bin/.cue
28 - .bin/.toc
29 - .img/.ccd/.sub
30 - .mdf/.mds
31 - .Z/.Z.table
32 - .bz/.bz.table
33 - .ZNX/.ZNX.table (partial)
34 - EBOOT.PBP (PSP, partial)
35
36 CDDA (CD audio) only supported when .cue/.toc/.ccd/.mds files are present.
37 There is support for redump.org .sbi files, which can be used instead of
38 .sub files to save space (name it the same as .cue/.bin, just use .sbi
39 extension). This is required for Libcrypt copy protected game support.
40
41 The emulator can simulate BIOS, which means BIOS files are not required,
42 however implementation is not complete and some games still need real BIOS
43 to work. To use real BIOS, copy uncompressed BIOS files to
44 [sd card]/pandora/appdata/pcsx_rearmed/bios/
45 then select the BIOS you want to use in Options->BIOS/Plugins menu.
46
47 Analog controllers are supported using nubs, but this is disabled by
48 default and needs to be enabled in 'Controls' menu.
49 There is also touchscreen based GunCon support, which also requires
50 appropriate controller selected in controls configuration.
51
52
53 Plugins
54 -------
55
56 GPU (graphics) and SPU (sound) plugins can be selected in
57 [BIOS/Plugins] menu:
58
59 builtin_gpu    - the P.E.Op.S. GPU plugin, most accurate but slow.
60 gpuPCSX4ALL.so - plugin from PCSX4ALL project. Faster but has some glitches.
61 gpuGLES.so     - experimental port of P.E.Op.S. MesaGL plugin to OpenGL ES.
62                  Occasionally faster but has lots of glitches and seems to
63                  be rather unstable (may crash the system).
64 builtin_spu    - P.E.Op.S. SPU plugin.
65 spunull.so     - NULL plugin, i.e. no sound emulation.
66
67
68 Changelog
69 ---------
70
71 r10 (2011-09-23)
72 + added fixed frameskip option
73 * fixed a crash in PCSX4ALL GPU plugin
74 * fixed several dynarec compatibility related issues (hopefully)
75 * fixed several SPU regressions from r9
76 * fixed frame limiter issue that sometimes caused stuttering
77 * fixed some minor GUI issues
78
79 r9 (2011-08-13)
80 * fixed various dynarec integration issues that were causing instability
81 * merged latest Ari64 dynarec code for some performance improvement
82 * changed frameskip handling in builtin and PCSX4ALL plugins,
83   fixes some cases where it would not work
84 * merged PCSX4ALL 2.2 GPU code to it's plugin
85 * fixed PCSX4ALL GPU inline asm, was miscompiling for ARMv7.
86 + added CDDA handling for eboot format
87 * improved CDDA handling for all image formats that support it
88 * various compatibility/accuracy improvements
89 * optimized PEOPS SPU core
90 * various menu adjustments
91 * changed scaling options a bit, there are now two 4:3 options:
92   integer and fractional
93 + added some basic memory card manager, which allows to change
94   or remove cards (remove needed for Tenka)
95 + added GunCon support
96 + added gpuPEOPS2 plugin (peops rendering + new emulation code)
97
98 r8 (2011-03-22)
99 * improved recompiler performance for some games
100 * fixed a few recompiler related compatibility issues
101   (also fixes broken memcard support in some games)
102 * fixed some graphics problems caused by frameskip.
103   Note that not all problems were fixed, so if you see graphics
104   glitches try turning off frameskip or using different GPU plugin.
105 + added screenshot function
106 + added some code to attempt to sync with pandora's LCD better
107 * merged a few compatibility fixes from PCSX-Reloaded
108 * fixed and issue with external controllers
109 * added experimental ability to use nubs as buttons
110
111 r7 (2011-03-02)
112 + implemented most used GTE operations in NEON
113 * merged latest Ari64's recompiler patches
114 * removed some code from the recompiler that is unneeded for R3k
115 * added some special handlers for constant reads
116 * some moderate builtin GPU and SPU optimizations
117 + added redump.org SBI support
118 * tuned frameskip code again
119 * fixed one 'analog controller not working' issue
120 * fixed a crash in builtin gpu code
121 * fixed cdrom slowdown issue
122 * fixed my stupid bug in the recompiler that slowed down
123   recompilation a lot
124 * some other refactoring
125
126 r6 (2011-02-10)
127 + added analog controller support using nubs (disabled by default)
128 + added control config saving
129 + added support for ingame actions (eg. savestate load)
130 + added 'auto' region option and made it default
131 + added cd swap functionality
132 + added maemo frontend from Bonapart
133   (with some tuning, source code only)
134 * reworked key configuration to be less confusing
135 * fixed 'SPU IRQ wait' option sometimes causing noise
136   and turned it on by default
137 * fixed mono xa masking (was causing noise)
138 * fixed word access macros in dfxvideo (darkness problem)
139 * changed GPU DMA timing back to 1.92 levels
140 * backported more fixes from PCSX-Reloaded project
141   (mostly shalma's work, see GIT)
142 * fixed a few more recompiler issues
143 + fixed frameskip in builtin plugin
144
145 r5 (2011-01-31)
146 + added support for .bz format, also partial support for
147   .znx and eboot.pbp formats
148 + merged latest cdrom code from PCSX-Reloaded project
149 * fixed remaining savestate incompatibilities between PCSX4ALL
150   and P.E.Op.S. GPU plugins
151 * fixed channel disable preventing irqs in P.E.Op.S. SPU plugin
152 * fixed some alignment issues
153 + added handling for branches in delay slots
154 + fixed some unexpected drops to menu
155 * fixed lots of recompiler related issues (see GIT)
156 + added watchdog thread to detect emulator lockups
157 * minor frontend adjustments
158
159 r4 (2011-01-15)
160 + added real BIOS support (and various things for it to work)
161 * fixed various recompiler issues
162 + added interpreter option (useful to overcome dynarec bugs)
163 * fixed some memory card related issues with HLE bios
164 * rewrote frame limiter (old was sometimes sleeping needlessly)
165
166 r3 (2011-01-05):
167 + added Pickle's port of gpu-gles from psx4m project
168 + added PCSX4ALL gpu as a plugin
169 * improved gpu plugin support
170 + added savestate preview
171 * various frontend fixes
172
173 r2 (2010-12-29):
174 * fixed memcard paths
175 * fixed a keybind copy-paste bug
176 * properly implemented pad handling
177   (inputs no longer control both emulated pads at once)
178 * fixed a crash caused by framebuffer out of range access
179 * fixed SWL/SWR handling (usually resulted in graphic glitches)
180 * fixed BxxZAL (Medal of Honor)
181 * fixed alignment crash in color space conversion code (Lunar)
182 * fixed SWC2 occasional use of wrong address register (Parasite Eve)
183 * fixed firstfile() handling in HLE BIOS (broken memory cards in some games)
184 + added per-game configs (controls still not saved though)
185 + added simple plugin select interface to the menu
186
187 r1 (2010-12-25):
188 * initial release
189
190
191 Credits / License
192 -----------------
193
194 Emulator core:
195
196 (C) 1999-2003 PCSX Team
197         (c) 1998 Vision Thing
198         Linuzappz     <linuzappz@pcsx.net>
199         Shadow        <shadow@pcsx.net>
200         Pete Bernett  <psswitch@online.de>
201         NoComp        <NoComp@mailcity.com>
202         Nik3d
203         Akumax        <akumax@pcsx.net>
204
205 (C) 2005-2009 PCSX-df Team
206         (c) Ryan Schultz <schultz.ryan@gmail.com>
207         (c) Andrew Burton <adb@iinet.net.au>
208         (c) Stephen Chao <schao@myrealbox.com>
209         (c) Marcus Comstedt <marcus@mc.pp.se>
210         Stefan Sikora <hoshy@schrauberstube.de>
211
212 (C) 2009-2011 PCSX-Reloaded Team
213         edgbla (Root counters, various core/plugin fixes)
214         shalma (GTE Divider, many core improvements, sound plugin fixes)
215         Firnis (GTE code from PCSX-Revolution Project)
216         Gabriele Gorla (MDEC decoder)
217         Peter Collingbourne (Various core/psxbios fixes)
218         Dario, NeToU, siveritas (Various bugfixes)
219         Wei Mingzhi (Maintainer, input plugin, iso/cheat support, misc stuff)
220
221 PCSX4ALL GPU plugin:
222         (C) 2010 PCSX4ALL Team
223         (C) 2010 Unai
224         Franxis <franxism@gmail.com>
225         Chui <sdl_gp32@yahoo.es>
226
227 GLES plugin (psx4m project):
228         (C) 1999-2009 by Pete Bernert
229         EQ
230         Olli Hinkka
231         Proger
232         Pickle
233
234 builtin GPU/SPU plugin:
235         (C) Pete Bernert and the P.E.Op.S. team
236
237 builtin SPU plugin:
238         (C) Pete Bernert and the P.E.Op.S. team
239         (C) SPU2-X, gigaherz, Pcsx2 Development Team
240         shalma
241
242 MIPS->ARM recompiler:
243         (C) 2009-2011 Ari64
244
245 integration, optimization and frontend:
246         (C) 2010-2011 notaz
247
248 some implementation ideas (and maybe code?) likely originated from
249 MAME/smf/pSXauthor and were integrated by various people to PCSX.
250
251 Source code is released under GNU GPL license, version 2 or later.
252 See COPYING included in the archive (.pnd can be extracted using unsquashfs).
253 The source code is available in a GIT repository at:
254
255 git://notaz.gp2x.de/~notaz/pcsx_rearmed.git
256