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