home · contact · privacy
7DRL: Don't use default ThingTypes that corpse to SLIPPERS.
[plomrogue] / README
1 7DRL 2015 project: Please the Island God
2 ========================================
3
4 Description
5 -----------
6
7 See <http://www.plomlompom.de/PlomRogue/plomwiki.php?title=7DRL2015Day2>
8 and <http://www.plomlompom.de/PlomRogue/plomwiki.php?title=7DRL2015Day3>.
9
10 System requirements / installation / running the game
11 -----------------------------------------------------
12
13 The game is expected to run:
14 - on Unix systems with a vt100-like terminal environment (xterm will do)
15 - that contain the ncurses library
16 - and Python3 (version >= 3.2.3).
17
18 To build it, this is furthermore necessary:
19 - gcc (version >= 4.7.2); some llvm masked as gcc was tested successfully on OSX
20 - libc library headers (libc6-dev?)
21 - ncurses library headers (libncurses5-dev?)
22
23 To build and start, do the following steps:
24
25 $ ./redo
26 $ ./roguelike
27
28 (If you got a version of djb's redo build system installed and in your $PATH,
29 you could also do a simple "redo" instead of "./redo". The ./redo script calls a
30 simple partial shell script implementation of redo stored below
31 ./build/redo_scripts/, written by Nils Dagsson Moskopp a.k.a. erlehmann.)
32
33 There are two executables ./roguelike-server and ./roguelike-client.
34 ./roguelike is a pre-existing shell script that merely executes both of them,
35 with the server as a background job. You can also ignore the script and start
36 any of the two by hand.
37
38 Keybindings
39 -----------
40
41 a - let AI decide move
42
43 w - move north-west
44 e - move north-east
45 s - move west
46 d - move east
47 x - move south-west
48 c - move south-east
49
50 l - toggle "look" mode, investigate map cells by moving a cursor over the map
51     instead of the player avatar
52
53 p - pick up item
54 D - drop item selected in inventory
55 u - use item selected in inventory
56
57 UP - navigate upwards in Inventory
58 DOWN - navigate downwards in inventory
59
60 Replay game recording
61 ---------------------
62
63 Once you start a new world, every move of yours is recorded in a file called
64 "record". It gets overwritten when a new game world is started after deletion
65 of the "savefile" file. Run "./roguelike -s" to watch the current game's
66 recording from the beginning. Hit any player action key to increment turns (they
67 will not trigger the actions usually mapped to them, only repeat the actions
68 done at that point in the game as defined in the "record" file). Keys to manage
69 windows, scroll on the map and quit the program do their usual thing. Append a
70 number to the -s option (like "-s100") to start the recording at the respective
71 turn number.
72
73 Hacking / server internals and configuration
74 --------------------------------------------
75
76 The game world is set up and made subject to player commands by
77 ./roguelike-server. It's controlled by commands explained in the file
78 ./SERVER_COMMANDS. The server usually reads these from the files ./server/in
79 (written to by ./roguelike-client), ./confserver/world, ./record and ./savefile.
80
81 All source files are thoroughly documented to explain more details of
82 plomrogue's internals. The ./roguelike-server executable can be run with a -v
83 option for helpful debugging info (mostly: what messages the client sends to the
84 server). Server and client communicate via files in the ./server/ directory
85 (generated when the server is first run). The ./server/in file is read by the
86 server for newline-delimited commands. The ./server/out file contains server
87 messages to be read by clients. The ./server/worldstate file contains a
88 serialized representation of the game world's data as it is to be visible to
89 the player / the player's client.