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