release r9
[pcsx_rearmed.git] / pandora / readme.txt
index 36c55d9..4f2cbed 100644 (file)
@@ -1,6 +1,8 @@
 
 PCSX-ReARMed - yet another PCSX fork
 
+http://notaz.gp2x.de/pcsx_rearmed.php
+
 
 About
 -----
@@ -8,11 +10,11 @@ About
 PCSX ReARMed is yet another PCSX fork based on the PCSX-Reloaded project,
 which itself contains code from PCSX, PCSX-df and PCSX-Revolution. This
 version is ARM architecture oriented and features MIPS->ARM recompiler by
-Ari64. It was created for Pandora handheld, but should be usable on other
-devices after some code adjustments.
+Ari64, NEON GTE code and more performance improvements. It was created for
+Pandora handheld, but should be usable on other devices after some code
+adjustments (N900 version is also available).
 
-It does not, however, have anything in common with similar psx4all and
-pcsx4all projects, except that all of these are PCSX ports.
+PCSX ReARMed features GPU plugin from PCSX4ALL project.
 
 
 Usage
@@ -21,25 +23,222 @@ Usage
 This version features a framebuffer driven menu that can be used to run
 games and configure the emulator.
 
-Supportd CD image formats:
-- .cue/.bin
-- .toc/.bin
-- .img
-- .mds
+Supported CD image formats:
+- .bin/.cue
+- .bin/.toc
+- .img/.ccd/.sub
+- .mdf/.mds
 - .Z/.Z.table
-
-CDDA (CD audio) support requires .cue/.bin format.
+- .bz/.bz.table
+- .ZNX/.ZNX.table (partial)
+- EBOOT.PBP (PSP, partial)
+
+CDDA (CD audio) only supported when .cue/.toc/.ccd/.mds files are present.
+There is support for redump.org .sbi files, which can be used instead of
+.sub files to save space (name it the same as .cue/.bin, just use .sbi
+extension). This is required for Libcrypt copy protected game support.
+
+The emulator can simulate BIOS, which means BIOS files are not required,
+however implementation is not complete and some games still need real BIOS
+to work. To use real BIOS, copy uncompressed BIOS files to
+[sd card]/pandora/appdata/pcsx_rearmed/bios/
+then select the BIOS you want to use in Options->BIOS/Plugins menu.
+
+Analog controllers are supported using nubs, but this is disabled by
+default and needs to be enabled in 'Controls' menu.
+There is also touchscreen based GunCon support, which also requires
+appropriate controller selected in controls configuration.
+
+
+Plugins
+-------
+
+GPU (graphics) and SPU (sound) plugins can be selected in
+[BIOS/Plugins] menu:
+
+builtin_gpu    - the P.E.Op.S. GPU plugin, most accurate but slow.
+gpuPCSX4ALL.so - plugin from PCSX4ALL project. Faster but has some glitches.
+gpuGLES.so     - experimental port of P.E.Op.S. MesaGL plugin to OpenGL ES.
+                 Occasionally faster but has lots of glitches and seems to
+                 be rather unstable (may crash the system).
+builtin_spu    - P.E.Op.S. SPU plugin.
+spunull.so     - NULL plugin, i.e. no sound emulation.
+
+
+Changelog
+---------
+
+r9 (2011-08-13)
+* fixed various dynarec integration issues that were causing instability
+* merged latest Ari64 dynarec code for some performance improvement
+* changed frameskip handling in builtin and PCSX4ALL plugins,
+  fixes some cases where it would not work
+* merged PCSX4ALL 2.2 GPU code to it's plugin
+* fixed PCSX4ALL GPU inline asm, was miscompiling for ARMv7.
++ added CDDA handling for eboot format
+* improved CDDA handling for all image formats that support it
+* various compatibility/accuracy improvements
+* optimized PEOPS SPU core
+* various menu adjustments
+* changed scaling options a bit, there are now two 4:3 options:
+  integer and fractional
++ added some basic memory card manager, which allows to change
+  or remove cards (remove needed for Tenka)
++ added GunCon support
++ added gpuPEOPS2 plugin (peops rendering + new emulation code)
+
+r8 (2011-03-22)
+* improved recompiler performance for some games
+* fixed a few recompiler related compatibility issues
+  (also fixes broken memcard support in some games)
+* fixed some graphics problems caused by frameskip.
+  Note that not all problems were fixed, so if you see graphics
+  glitches try turning off frameskip or using different GPU plugin.
++ added screenshot function
++ added some code to attempt to sync with pandora's LCD better
+* merged a few compatibility fixes from PCSX-Reloaded
+* fixed and issue with external controllers
+* added experimental ability to use nubs as buttons
+
+r7 (2011-03-02)
++ implemented most used GTE operations in NEON
+* merged latest Ari64's recompiler patches
+* removed some code from the recompiler that is unneeded for R3k
+* added some special handlers for constant reads
+* some moderate builtin GPU and SPU optimizations
++ added redump.org SBI support
+* tuned frameskip code again
+* fixed one 'analog controller not working' issue
+* fixed a crash in builtin gpu code
+* fixed cdrom slowdown issue
+* fixed my stupid bug in the recompiler that slowed down
+  recompilation a lot
+* some other refactoring
+
+r6 (2011-02-10)
++ added analog controller support using nubs (disabled by default)
++ added control config saving
++ added support for ingame actions (eg. savestate load)
++ added 'auto' region option and made it default
++ added cd swap functionality
++ added maemo frontend from Bonapart
+  (with some tuning, source code only)
+* reworked key configuration to be less confusing
+* fixed 'SPU IRQ wait' option sometimes causing noise
+  and turned it on by default
+* fixed mono xa masking (was causing noise)
+* fixed word access macros in dfxvideo (darkness problem)
+* changed GPU DMA timing back to 1.92 levels
+* backported more fixes from PCSX-Reloaded project
+  (mostly shalma's work, see GIT)
+* fixed a few more recompiler issues
++ fixed frameskip in builtin plugin
+
+r5 (2011-01-31)
++ added support for .bz format, also partial support for
+  .znx and eboot.pbp formats
++ merged latest cdrom code from PCSX-Reloaded project
+* fixed remaining savestate incompatibilities between PCSX4ALL
+  and P.E.Op.S. GPU plugins
+* fixed channel disable preventing irqs in P.E.Op.S. SPU plugin
+* fixed some alignment issues
++ added handling for branches in delay slots
++ fixed some unexpected drops to menu
+* fixed lots of recompiler related issues (see GIT)
++ added watchdog thread to detect emulator lockups
+* minor frontend adjustments
+
+r4 (2011-01-15)
++ added real BIOS support (and various things for it to work)
+* fixed various recompiler issues
++ added interpreter option (useful to overcome dynarec bugs)
+* fixed some memory card related issues with HLE bios
+* rewrote frame limiter (old was sometimes sleeping needlessly)
+
+r3 (2011-01-05):
++ added Pickle's port of gpu-gles from psx4m project
++ added PCSX4ALL gpu as a plugin
+* improved gpu plugin support
++ added savestate preview
+* various frontend fixes
+
+r2 (2010-12-29):
+* fixed memcard paths
+* fixed a keybind copy-paste bug
+* properly implemented pad handling
+  (inputs no longer control both emulated pads at once)
+* fixed a crash caused by framebuffer out of range access
+* fixed SWL/SWR handling (usually resulted in graphic glitches)
+* fixed BxxZAL (Medal of Honor)
+* fixed alignment crash in color space conversion code (Lunar)
+* fixed SWC2 occasional use of wrong address register (Parasite Eve)
+* fixed firstfile() handling in HLE BIOS (broken memory cards in some games)
++ added per-game configs (controls still not saved though)
++ added simple plugin select interface to the menu
+
+r1 (2010-12-25):
+* initial release
 
 
 Credits / License
 -----------------
 
+Emulator core:
+
 (C) 1999-2003 PCSX Team
+       (c) 1998 Vision Thing
+       Linuzappz     <linuzappz@pcsx.net>
+       Shadow        <shadow@pcsx.net>
+       Pete Bernett  <psswitch@online.de>
+       NoComp        <NoComp@mailcity.com>
+       Nik3d
+       Akumax        <akumax@pcsx.net>
+
 (C) 2005-2009 PCSX-df Team
-(C) 2009-2010 PCSX-Reloaded Team
-GPU and SPU code by Pete Bernert and the P.E.Op.S. team
-ARM recompiler (C) 2009-2010 Ari64
-integration, optimization and frontend (C) 2010 notaz
+       (c) Ryan Schultz <schultz.ryan@gmail.com>
+       (c) Andrew Burton <adb@iinet.net.au>
+       (c) Stephen Chao <schao@myrealbox.com>
+       (c) Marcus Comstedt <marcus@mc.pp.se>
+       Stefan Sikora <hoshy@schrauberstube.de>
+
+(C) 2009-2011 PCSX-Reloaded Team
+       edgbla (Root counters, various core/plugin fixes)
+       shalma (GTE Divider, many core improvements, sound plugin fixes)
+       Firnis (GTE code from PCSX-Revolution Project)
+       Gabriele Gorla (MDEC decoder)
+       Peter Collingbourne (Various core/psxbios fixes)
+       Dario, NeToU, siveritas (Various bugfixes)
+       Wei Mingzhi (Maintainer, input plugin, iso/cheat support, misc stuff)
+
+PCSX4ALL GPU plugin:
+       (C) 2010 PCSX4ALL Team
+       (C) 2010 Unai
+       Franxis <franxism@gmail.com>
+       Chui <sdl_gp32@yahoo.es>
+
+GLES plugin (psx4m project):
+       (C) 1999-2009 by Pete Bernert
+       EQ
+       Olli Hinkka
+       Proger
+       Pickle
+
+builtin GPU/SPU plugin:
+       (C) Pete Bernert and the P.E.Op.S. team
+
+builtin SPU plugin:
+       (C) Pete Bernert and the P.E.Op.S. team
+       (C) SPU2-X, gigaherz, Pcsx2 Development Team
+       shalma
+
+MIPS->ARM recompiler:
+       (C) 2009-2011 Ari64
+
+integration, optimization and frontend:
+       (C) 2010-2011 notaz
+
+some implementation ideas (and maybe code?) likely originated from
+MAME/smf/pSXauthor and were integrated by various people to PCSX.
 
 Source code is released under GNU GPL license, version 2 or later.
 See COPYING included in the archive (.pnd can be extracted using unsquashfs).