diff options
author | Sebastian Leonhardt <sebastian.leonhardt@web.de> | 2016-01-08 01:05:36 +0100 |
---|---|---|
committer | Solomon Peachy <pizza@shaftnet.org> | 2024-06-30 17:24:16 -0400 |
commit | 102c3742487dba76ec72d5f56a2c3041344b2d68 (patch) | |
tree | 4931ad34d2cc0bac56d9984b9ead355d012ad63a /apps/plugins/xrick/README.md | |
parent | 6f1e67e5e318ba2fd0f5ec1892c7b6633ec6521c (diff) | |
download | rockbox-102c3742487dba76ec72d5f56a2c3041344b2d68.tar.gz rockbox-102c3742487dba76ec72d5f56a2c3041344b2d68.zip |
added xrick game
original xrick code by 'BigOrno' at:
http://www.bigorno.net/xrick/
Rockbox port, plus bugfixes at:
https://github.com/pierluigi-vicinanza/xrick
Further changes:
* Additonal fixes from g#3026
* Port to modern plugin API
* Add Pluginlib keymap fallback
* Support all >1bpp screens
* Fix build warnings in miniz
* Better error message when resources are missing
Change-Id: Id83928bc2539901b0221692f65cbca41389c58e7
Diffstat (limited to 'apps/plugins/xrick/README.md')
-rw-r--r-- | apps/plugins/xrick/README.md | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/apps/plugins/xrick/README.md b/apps/plugins/xrick/README.md new file mode 100644 index 0000000000..ecb4c19b50 --- /dev/null +++ b/apps/plugins/xrick/README.md | |||
@@ -0,0 +1,88 @@ | |||
1 | xrick | ||
2 | ===== | ||
3 | |||
4 | xrick is a clone of [Rick Dangerous](http://en.wikipedia.org/wiki/Rick_Dangerous), | ||
5 | known to run on Linux, Windows, BeOs, Amiga, QNX, all sorts of gaming consoles... | ||
6 | |||
7 | License agreement & legal bable | ||
8 | ------------------------------- | ||
9 | |||
10 | * Copyright (C) 1998-2002 BigOrno (bigorno@bigorno.net) (http://www.bigorno.net/xrick/) | ||
11 | * Copyright (C) 2008-2014 Pierluigi Vicinanza (pierluigi DOT vicinanza AT gmail.com) | ||
12 | |||
13 | I (BigOrno) have written the initial [xrick](http://www.bigorno.net/xrick/) code. | ||
14 | However, graphics and maps and sounds are by the authors of the original Rick Dangerous | ||
15 | game, and "Rick Dangerous" remains a trademark of its owner(s) -- maybe | ||
16 | Core Design (who wrote the game) or FireBird (who published it). | ||
17 | As of today, I have not been successful at contacting Core Design. | ||
18 | |||
19 | This makes it a bit difficult to formally release the whole code, | ||
20 | including data for graphics and maps and sounds, under the terms of | ||
21 | licences such as the GNU General Public Licence. So the code is | ||
22 | released "in the spirit" of the GNU GPL. Whatever that means. | ||
23 | |||
24 | This program is distributed in the hope that it will be useful, but | ||
25 | WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY | ||
26 | or FITNESS FOR A PARTICULAR PURPOSE. | ||
27 | |||
28 | Building | ||
29 | -------- | ||
30 | |||
31 | **Requirements:** | ||
32 | |||
33 | * [CMake](http://www.cmake.org/) | ||
34 | * [SDL](https://www.libsdl.org/download-1.2.php) version 1.2.x | ||
35 | * [zlib](http://www.zlib.net/) | ||
36 | |||
37 | 1. *Create a build directory* | ||
38 | |||
39 | ``` | ||
40 | $ cd xrick-x.x.x | ||
41 | $ mkdir build | ||
42 | $ cd build | ||
43 | ``` | ||
44 | |||
45 | 2. *Generate your Makefile* | ||
46 | |||
47 | `$ cmake ../source/xrick/projects/cmake` | ||
48 | |||
49 | 3. *Build* | ||
50 | |||
51 | `$ make` | ||
52 | |||
53 | 4. *Install (optional)* | ||
54 | |||
55 | `$ make install` | ||
56 | |||
57 | Platform specific notes can be found in README.platforms. | ||
58 | |||
59 | Usage | ||
60 | ----- | ||
61 | |||
62 | `xrick --help` will tell you all about command-line options. | ||
63 | |||
64 | Controls | ||
65 | -------- | ||
66 | |||
67 | - left, right, up (jump) or down (crawl): arrow keys or Z, X, O and K. | ||
68 | - fire: SPACE, end: E, pause: P, exit: ESC. | ||
69 | - use left, right, up, down + fire to poke something with your stick, | ||
70 | lay a stick of dynamite, or fire a bullet. | ||
71 | - toggle fullscreen: F1 ; zoom in/out: F2, F3. | ||
72 | - mute: F4 ; volume up/down: F5, F6. | ||
73 | - cheat modes, "trainer": F7 ; "never die": F8 ; "expose": F9. | ||
74 | |||
75 | More details at http://www.bigorno.net/xrick/ | ||
76 | |||
77 | Release History | ||
78 | --------------- | ||
79 | |||
80 | Please see the file called CHANGELOG.md. | ||
81 | |||
82 | Contacts | ||
83 | -------- | ||
84 | |||
85 | Report problems or ask questions to: | ||
86 | |||
87 | * _BigOrno_ (bigorno@bigorno.net) | ||
88 | * _Pierluigi Vicinanza_ (pierluigi DOT vicinanza AT gmail.com) | ||