loader: unmix wiz start/select, pnd root check
[ginge.git] / readme.txt
CommitLineData
db9191ed 1\r
2GINGE - Ginge Is Not GP2X Emulator\r
7000b522 3release 3\r
db9191ed 4\r
5(C) notaz, 2010\r
6http://notaz.gp2x.de/\r
7\r
8\r
9About\r
10-----\r
11\r
7000b522 12Ginge is an application that can run many GP2X F100/F200, Wiz games and\r
13programs on other ARM Linux platforms, which currently includes Pandora\r
14and Wiz itself. It is not a full hardware emulator like MAME, PicoDrive or\r
15similar, it does not emulate the CPU. It can be considered as compatibility\r
16layer similar to Wine on PC Linux, however it does emulate small portion of\r
17MMSP2 and Pollux system-on-chips. It operates by hooking certain system calls\r
18and using realtime patching of code that accesses memory mapped hardware\r
19directly.\r
db9191ed 20\r
21\r
22Usage\r
23-----\r
24\r
25Ginge comes with a launcher that is started when you run Ginge. The launcher\r
26can then be used to start GP2X software, which will either run if it's\r
27compatible, or just return back to the menu if it is not. In some cases it\r
28might hang though.\r
29\r
7000b522 30Keys are mapped to corresponding keys on both pandora and Wiz, except:\r
31\r
32Key Pandora Wiz\r
33Stick Push 1 unmapped\r
34Volume up/down '.', ',' Volume up/down\r
35\r
36On pandora pressing 'q' will exit the menu or try to kill current application.\r
37\r
db9191ed 38\r
39Structure\r
40---------\r
41\r
42Ginge actually consists of 4 independent executables and a few scripts:\r
43\r
44+ ginge_sloader - loader of static executables\r
45+ ginge_dyn - dynamic executable handler\r
46+ ginge_prep - .gpe parser that selects the right handler from above\r
47+ gp2xmenu - the launcher/menu program\r
48+ ginge_dyn.sh - environment setup script for ginge_dyn\r
49+ ginge.sh/gpe - menu launcher script\r
50\r
51The menu is optional and can be replaced or bypassed completely. The only thing\r
52it does is running ginge_prep on GP2X .gpe program, ginge_prep handles the rest.\r
53\r
54\r
adb79840 55Changelog\r
56---------\r
57\r
7000b522 58r3\r
59* improved exec handling, mostly for gpecomp.\r
60+ added preliminary Wiz support, pcsx4all works.\r
61* Wiz: since some stuff is written to /tmp, mount tmpfs there when starting\r
62 to avoid wearing down flash.\r
63\r
adb79840 64r2\r
65* improved exit handling\r
66* Wiz: should now return to Wiz menu after gp2xmenu exit\r
67\r
68r1 - initial release\r
69+ icons provided by Inder\r
70\r
71\r
db9191ed 72License\r
73-------\r
74\r
75gp2xmenu is based on GPH GPL source (http://www.gnu.org/licenses/gpl.html).\r
76Source is available at http://notaz.gp2x.de/releases/ginge/gp2xmenu.tar.bz2\r
77\r
78Ginge may come with some libraries. Those libraries are unmodified copies\r
79of ones found in root filesystems in GP2X and Wiz and are included to more\r
adb79840 80accurately reproduce environment found on GP2X. Their source code may or may\r
81not be available, I did not I use it, but whatever I found is mirrored here:\r
82http://notaz.gp2x.de/downloads/gp2x/src/410_all/\r
db9191ed 83\r
84Remaining portion is released under custom closed source license. It is not\r
85derived from gp2xmenu and is completely standalone, the menu is only included\r
86for user's convenience.\r
87\r
88Redistribution and use of program's binaries and helper scripts, with or without\r
89modification, is permitted provided that the following conditions are met:\r
90 * This readme is included in unmodified form.\r
91 * The program in any of it's forms is not sold or used as part of any\r
92 commercial package, including pre-installed or included in any kind of\r
93 portable device.\r
adb79840 94 * It is not bundled and distributed with any GP2X program without respective\r
db9191ed 95 program's author's permission.\r
96\r
97THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND\r
98ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
99WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
100DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER BE LIABLE FOR ANY\r
101DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
102(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
103LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\r
104ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
105(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\r
106SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
107\r