1 NOTE: This is the PlomRogue engine's RADME text, assuming certain configuration
2 defaults not present in the 7DRL game. So parts of it may not apply to this
8 plomlompom tries to build his own roguelike. It doesn't do much yet (although
9 plomlompom has insanely ambitious long-term plans).
11 You can move around a player on an island and meet different enemies. You have 5
12 hitpoints to lose before death. Enemies start with different amounts of
13 hitpoints, depending on their species. Dead enemies become dirt, skeletons, or
14 food to consume (each turn reduces one's "satiation", and the lower it is, the
15 stronger the chance of suffering from hunger and thereby losing hitpoints). Note
16 that different kinds of movements/actions take different numbers of turns to
19 Enemies' AI is very dumb so far: Each turn, they look out for actors of
20 different species to flee from (if their type starts out with more hitpoints
21 than they have) or (if the opposite is the case) move towards for purposes of
22 attack. If they see no enemy, they search for and consume "magic meat".
24 Every move of yours re-writes a file "savefile" that describes the new state of
25 dthe world, if more than 15 seconds have passed since its last writing. Once you
26 re-start the game, the game state is recreated from the "savefile" file. To
27 start over in a new world, simply delete this file.
29 System requirements / installation / running the game
30 -----------------------------------------------------
32 The game is expected to run:
33 - on Unix systems with a vt100-like terminal environment (xterm will do)
34 - that contain the ncurses library
35 - and Python3 (version >= 3.2.3).
37 To build it, this is furthermore necessary:
38 - gcc (version >= 4.7.2); some llvm masked as gcc was tested successfully on OSX
39 - libc library headers (libc6-dev?)
40 - ncurses library headers (libncurses5-dev?)
42 To build and start, do the following steps:
47 (If you got a version of djb's redo build system installed and in your $PATH,
48 you could also do a simple "redo" instead of "./redo". The ./redo script calls a
49 simple partial shell script implementation of redo stored below
50 ./build/redo_scripts/, written by Nils Dagsson Moskopp a.k.a. erlehmann.)
52 ./redo generates the executable ./roguelike-client (and the library
53 ./libplomrogue.so used by the executable ./roguelike-server).
55 ./roguelike is a pre-existing shell script that merely executes both executables
56 ./roguelike-client and ./roguelike-server, with the server as a background job.
57 You can also ignore the script and start the two by hand.
59 Client's keybindings and window management
60 ------------------------------------------
62 Multiple windows may fill the screen. One of these will be selected as "active"
63 – identified by dollar signs enclosing its title. Active windows may come with
64 window-specific keybindings. Furthermore, global keybindings are available no
65 matter what window is selected.
67 Hit "W" (per default global keybindings) to switch the active window to a view
68 that allows changing its geometry. One more hit on "W" switches the window to a
69 view that sports (and allows changing its) window-specific keybindings. (One
70 further "W" will return the window to its default, "normal" view.) The global
71 keybindings are visible (and can be changed) in the "Set global keys" window,
72 those of the window geometry configuration in the "Set window geometry keys"
73 window, and those of the window-specific keybindings configuration in the "Set
74 window keybinding keys" window; by default, the latter two are not visible, but
75 may be turned on by (per default keybindings) hitting the keys "F6" and "F7".
77 Keybindings and default window selection / visibilities / geometries are read
78 from the textfile ./confclient/interface_conf by default, or by another one
79 named by the -i command line option of the client. Some other default window
80 configurations are stored below ./confclient/single_windows/: "map", "info",
81 "inventory" and "log". Each of these opens up only a single window into the
82 client, filling up the entire terminal. This may be useful for running multiple
83 clients in parallel in multiple terminal windows that can be managed by one's
84 own window manager choice, instead of relying on plomrogue-client's bizarre
85 in-client window management.
90 Once you start a new world, every move of yours is recorded in a file called
91 "record". It gets overwritten when a new game world is started after deletion
92 of the "savefile" file. Run "./roguelike -s" to watch the current game's
93 recording from the beginning. Hit any player action key to increment turns (they
94 will not trigger the actions usually mapped to them, only repeat the actions
95 done at that point in the game as defined in the "record" file). Keys to manage
96 windows, scroll on the map and quit the program do their usual thing. Append a
97 number to the -s option (like "-s100") to start the recording at the respective
100 Hacking / server internals and configuration
101 --------------------------------------------
103 The game world is set up and made subject to player commands by
104 ./roguelike-server. It's controlled by commands explained in the file
105 ./SERVER_COMMANDS. The server usually reads these from the files ./server/in
106 (written to by ./roguelike-client), ./confserver/world, ./record and ./savefile.
108 All source files are thoroughly documented to explain more details of
109 plomrogue's internals. The ./roguelike-server executable can be run with a -v
110 option for helpful debugging info (mostly: what messages the client sends to the
111 server). Server and client communicate via files in the ./server/ directory
112 (generated when the server is first run). The ./server/in file is read by the
113 server for newline-delimited commands. The ./server/out file contains server
114 messages to be read by clients. The ./server/worldstate file contains a
115 serialized representation of the game world's data as it is to be visible to
116 the player / the player's client.
projects / plomrogue / blob