X-Git-Url: https://plomlompom.com/repos/foo.html?a=blobdiff_plain;f=README;h=e03e08dafa7610b8fb323921a46740796d17c212;hb=40c0a0a1ec601efd0bce1fe331d2888aeff9ef6f;hp=71fad4ebcb739656f576c608c3557d5f748ded43;hpb=cb4bbc0c2d65535d1d47822d86ad88194243a31a;p=plomrogue diff --git a/README b/README index 71fad4e..e03e08d 100644 --- a/README +++ b/README @@ -1,71 +1,63 @@ -plomrogue -========= +7DRL 2015 project: Please the Island God +======================================== -plomlompom tries to build his own roguelike. It doesn't do much yet (although -plomlompom has insanely ambitious long-term plans). +Description +----------- -You can move around a player on an island and meet different enemies. You have 5 -hitpoints to lose before death. Enemies start with different amounts of -hitpoints, depending on their species. Dead enemies become dirt, skeletons or -"magic meat" -- such objects can be collected, and "magic meat" can be consumed -to gain hitpoints. Note that different kinds of movements/actions take different -numbers of turns to finish. - -Enemies' AI is very dumb so far: Each turn, they try to move towards their -shortest-path-wise nearest enemy (any animate being of a different species) -visible to them. If they see no enemy, they just wait. - -Every move of yours re-writes a file "savefile" that describes the new state of -the world. Once you re-start the game, the game state is recreated from the -"savefile" file. To start over in a new world, simply delete this file. +See +and . System requirements / installation / running the game ----------------------------------------------------- -The game is expected to run on Linux systems that contain the ncurses library. -(It may also work on other Unix-like systems with ncurses, who knows.) Do the -following steps: +The game is expected to run: +- on Unix systems with a vt100-like terminal environment (xterm will do) +- that contain the ncurses library +- and Python3 (version >= 3.2.3). + +To build it, this is furthermore necessary: +- gcc (version >= 4.7.2); some llvm masked as gcc was tested successfully on OSX +- libc library headers (libc6-dev?) +- ncurses library headers (libncurses5-dev?) + +To build and start, do the following steps: -$ git clone https://github.com/plomlompom/plomrogue -$ cd plomrogue $ ./redo $ ./roguelike -(If you got a redo build system installed and in your $PATH, you could also do a -simple "redo" instead of "./redo". The ./redo script calls a simple partial -shell script implementation of redo stored below build/redo_scripts/, written by -Nils Dagsson Moskopp a.k.a. erlehmann.) +(If you got a version of djb's redo build system installed and in your $PATH, +you could also do a simple "redo" instead of "./redo". The ./redo script calls a +simple partial shell script implementation of redo stored below +./build/redo_scripts/, written by Nils Dagsson Moskopp a.k.a. erlehmann.) -./redo generates two executables ./roguelike-server and ./roguelike-client. +There are two executables ./roguelike-server and ./roguelike-client. ./roguelike is a pre-existing shell script that merely executes both of them, with the server as a background job. You can also ignore the script and start -the two by hand. - -Client's keybindings and window management ------------------------------------------- - -In the client's default window configuration, the window appearing on the left -sports a list of keybindings available globally, and additionally via the window -selected as active. - -Hit "W" (per default keybindings) to switch the "active" window to a view that -allows changing its geometry. One more hit on "W" switches the window to a view -that allows changing its window-specific keybindings. The global keybindings can -be changed in the "Global keys" window, those of the window geometry -configuration in the "Window geometry keys" window, and those of the -window-specific keybindings configuration in the "Window keybinding keys" -window; by default, these three windows are not visible, but may be turned on by -(per default keybindings) hitting the "F6", "F7" and "F8" keys. - -Keybindings and default window selection / visibilities / geometries are read -from the textfile ./confclient/interface_conf by default, or by another one -named by the -i command line option of the client. Some other default window -configurations are stored below ./confclient/single_windows/: "map", "info", -"inventory" and "log". Each of these opens up only a single window into the -client, filling up the entire terminal. This may be useful for running multiple -clients in parallel in multiple terminal windows that can be managed by one's -own window manager choice, instead of relying on plomrogue-client's bizarre -in-client window management. +any of the two by hand. + +Keybindings +----------- + +a - let AI decide move + +w - move north-west +e - move north-east +s - move west +d - move east +x - move south-west +c - move south-east + +w - wait one turn + +l - toggle "look" mode, investigate map cells by moving a cursor over the map + instead of the player avatar + +p - pick up item +D - drop item selected in inventory +u - use item selected in inventory + +UP - navigate upwards in Inventory +DOWN - navigate downwards in inventory Replay game recording --------------------- @@ -84,10 +76,9 @@ Hacking / server internals and configuration -------------------------------------------- The game world is set up and made subject to player commands by -./roguelike-server. It's controlled by commands explained in the file … -The server usually reads these from the files ./server/in (written to by -./roguelike-client), ./confserver/world, ./record and ./savefile. See the file -./SERVER_COMMANDS for details. +./roguelike-server. It's controlled by commands explained in the file +./SERVER_COMMANDS. The server usually reads these from the files ./server/in +(written to by ./roguelike-client), ./confserver/world, ./record and ./savefile. All source files are thoroughly documented to explain more details of plomrogue's internals. The ./roguelike-server executable can be run with a -v