pnd scripts and icon
[ginge.git] / readme.txt
CommitLineData
ed233fce 1
2GINGE - Ginge Is Not GP2X Emulator
3
4(C) notaz, 2010
5http://notaz.gp2x.de/
6
7
8About
9-----
10
11Ginge is an application that can run many GP2X F100/F200 games on other ARM
12Linux platforms, which currently includes Wiz. It is not a full hardware
13emulator like MAME, PicoDrive or similar, it does not emulate the CPU. It can
14be considered as compatibility layer similar to Wine on PC Linux, however it
15does emulate small portion of MMSP2 system-on-chip. It operates by hooking
16certain system calls and using realtime patching of code that accesses memory
17mapped hardware directly.
18
19
20Usage
21-----
22
23Ginge comes with a launcher that is started when you run Ginge. The launcher
24can then be used to start GP2X software, which will either run if it's
25compatible, or just return back to the menu if it is not. In some cases it
26might hang though.
27
28
29Structure
30---------
31
32Ginge actually consists of 4 independent executables and a few scripts:
33
34+ ginge_sloader - loader of static executables
35+ ginge_dyn - dynamic executable handler
36+ ginge_prep - .gpe parser that selects the right handler from above
37+ gp2xmenu - the launcher/menu program
38+ ginge_dyn.sh - environment setup script for ginge_dyn
39+ ginge.sh/gpe - menu launcher script
40
41The menu is optional and can be replaced or bypassed completely. The only thing
42it does is running ginge_prep on GP2X .gpe program, ginge_prep handles the rest.
43
44
45License
46-------
47
48gp2xmenu is based on GPH GPL source (http://www.gnu.org/licenses/gpl.html).
49Source is available at
50
51Remaining portion is released under custom closed source license. It is not
52derived from gp2xmenu and is completely standalone, the menu is only included
53for user's convenience.
54
55Redistribution and use of program's binaries and helper scripts, with or without
56modification, is permitted provided that the following conditions are met:
57 * This readme is included in unmodified form.
58 * The program in any of it's forms is not sold or used as part of any
59 commercial package, including pre-installed or included in any kind of
60 portable device.
61 * It is not bundled or distributed with any GP2X program without respective
62 program's author's permission.
63
64THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
65ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
66WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
67DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER BE LIABLE FOR ANY
68DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
69(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
70LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
71ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
72(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
73SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
74