Adding README
[rfk-inform.git] / README
1 robotfindskitten
2 A Zen Simulation
3 Release 7 / Serial number 130320 / Inform v6.33
4
5      [-]       |\_/|        http://www.robotfindskitten.org
6      (+)=C     |o o|__      Leonard Richardson (C) 1997, 2000
7      | |       --*--__\     David Griffith (C) 2002-2013  (Inform Edition)
8      OOO       C_C(____)
9
10 This Zen simulation is based on the C version v1600003.248b
11 by Leonard Richardson (C) 1997, 2000.
12 Written originally for the Nerth Pork robotfindskitten contest.
13 Reimplemented in Inform by David Griffith (C) 2002.
14
15 Lots more information on robotfindskitten is available at
16 http://www.robotfindskitten.org.
17
18 In this game, you are Robot (#).  Your job is to find Kitten.  This
19 task is complicated by the existance of various things which are not
20 kitten.  Robot must touch items to determine if they are Kitten or
21 not.  Move Robot with the cursor keys, the numeric keypad, or
22 using the vi/rogue movement keys. The game ends when robotfindskitten.
23 Alternatively, you may end the game by hitting the Esc or Q keys.
24
25
26 =========
27 Build: ||
28 =========
29
30 The NKI files need to be converted into a form that can be included in 
31 an Inform6 program.  A Perl script, nki2inf.pl, is provided for this 
32 purpose.  Invoke it like this: "nki2inf.pl *.nki > nki.inf".  Now you 
33 can invoke Inform6 on kitten.inf
34
35
36 ========
37 Notes ||
38 ========
39 1) More than half of the code is taken up by non kitten items
40    (NKIs).  When I compiled the code with just five messages and
41    no debugging code, the resulting binary was less than 10k bytes.
42
43 2) If it wasn't already abundantly obvious, this program won't
44    compile to Glulx because of copious use of Z-machine assembly
45    instructions.
46       
47 3) Compiling for V5 or higher is required due to "style" calls.
48    Is there a reason why someone would want to compile this for V4
49    or previous?
50