Support compiling without mmap functions
[pcsx_rearmed.git] / README.md
1 PCSX-ReARMed - yet another PCSX fork
2 ====================================
3
4 ![CI (Linux)](https://github.com/notaz/pcsx_rearmed/workflows/CI%20(Linux)/badge.svg)
5
6 *see [readme.txt](readme.txt) for more complete documentation*
7
8 PCSX ReARMed is yet another PCSX fork based on the PCSX-Reloaded project,
9 which itself contains code from PCSX, PCSX-df and PCSX-Revolution. This
10 version is ARM architecture oriented and features MIPS->ARM recompiler by
11 Ari64, NEON GTE code and more performance improvements. It was created for
12 Pandora handheld, but should be usable on other devices after some code
13 adjustments (N900, GPH Wiz/Caanoo, PlayBook versions are also available).
14
15 PCSX ReARMed features ARM NEON GPU by Exophase, that in many cases produces
16 pixel perfect graphics at very high performance. There is also Una-i's GPU
17 plugin from PCSX4ALL project, and traditional P.E.Op.S. one.
18
19
20 PCSX-Reloaded
21 =============
22
23 PCSX-Reloaded is a forked version of the dead PCSX emulator, with a nicer
24 interface and several improvements to stability and functionality.
25
26 PCSX-Reloaded uses the PSEMU plugin interface to provide most functionality;
27 without them, you will not be able to use it to play games. PCSX-Reloaded
28 provides a number of plugins to provide basic functionality out of the box.
29
30 PCSX-Reloaded has a very capable Internal HLE BIOS that can run many games
31 without problems. It is recommended that you use it. However, if you own a
32 real PlayStation, you may be able to use your own BIOS image. PCSX-Reloaded
33 will find it in ~/.pcsx/bios/ or /usr/share/psemu/bios/ if you place it there.
34 This can improve compatibility, especially with certain games and with the
35 use of memory cards.
36
37 See the doc/ folder in the source, or /usr/share/doc/pcsx/ on Debian systems,
38 for more detailed information on PCSX-Reloaded. A UNIX manpage is also
39 available.