summaryrefslogtreecommitdiff
path: root/apps/plugins/xrick/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'apps/plugins/xrick/README.md')
-rw-r--r--apps/plugins/xrick/README.md88
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 @@
1xrick
2=====
3
4xrick is a clone of [Rick Dangerous](http://en.wikipedia.org/wiki/Rick_Dangerous),
5known to run on Linux, Windows, BeOs, Amiga, QNX, all sorts of gaming consoles...
6
7License 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
13I (BigOrno) have written the initial [xrick](http://www.bigorno.net/xrick/) code.
14However, graphics and maps and sounds are by the authors of the original Rick Dangerous
15game, and "Rick Dangerous" remains a trademark of its owner(s) -- maybe
16Core Design (who wrote the game) or FireBird (who published it).
17As of today, I have not been successful at contacting Core Design.
18
19This makes it a bit difficult to formally release the whole code,
20including data for graphics and maps and sounds, under the terms of
21licences such as the GNU General Public Licence. So the code is
22released "in the spirit" of the GNU GPL. Whatever that means.
23
24This program is distributed in the hope that it will be useful, but
25WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
26or FITNESS FOR A PARTICULAR PURPOSE.
27
28Building
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
371. *Create a build directory*
38
39 ```
40 $ cd xrick-x.x.x
41 $ mkdir build
42 $ cd build
43 ```
44
452. *Generate your Makefile*
46
47 `$ cmake ../source/xrick/projects/cmake`
48
493. *Build*
50
51 `$ make`
52
534. *Install (optional)*
54
55 `$ make install`
56
57Platform specific notes can be found in README.platforms.
58
59Usage
60-----
61
62`xrick --help` will tell you all about command-line options.
63
64Controls
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
75More details at http://www.bigorno.net/xrick/
76
77Release History
78---------------
79
80Please see the file called CHANGELOG.md.
81
82Contacts
83--------
84
85Report problems or ask questions to:
86
87* _BigOrno_ (bigorno@bigorno.net)
88* _Pierluigi Vicinanza_ (pierluigi DOT vicinanza AT gmail.com)