-plomrogue
-=========
+7DRL 2015 project: Please the Island God
+========================================
-plomlompom tries to build his own roguelike. Currently, it doesn't do much
-interesting, apart from managing keybindings and some ncurses windows in a
-bizarre fashion.
+Description
+-----------
+
+See <http://www.plomlompom.de/PlomRogue/plomwiki.php?title=7DRL2015Day2>
+and <http://www.plomlompom.de/PlomRogue/plomwiki.php?title=7DRL2015Day3>.
+
+System requirements / installation / running the game
+-----------------------------------------------------
+
+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?)
-You can move around a player and meet a number of different enemies. They move
-randomly and will only accidentally hit you. You have 5 hitpoints to lose before
-death; they have either 1, 3 or 9. Your score grows by killing enemies, to the
-amount of hitpoints each killed enemy started with.
+To build and start, do the following steps:
-The map gets generated randomly, too.
+$ ./redo
+$ ./roguelike
-There is only one save file (named "savefile"), and it gets overwritten each new
-turn. To start over with a new world, delete it.
+(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.)
-Install/run
+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
+any of the two by hand.
+
+Keybindings
-----------
-Dependencies: the ncurses library.
-
-git clone https://github.com/plomlompom/plomrogue
-cd plomrogue
-make
-./roguelike
-
-Keybindings and window configuration
-------------------------------------
-
-In the default window configuration, the window appearing on the left sports a
-list of keybindings available globally and additionally via the window currently
-selected as active.
-
-Hit "w" (per default keybindings) to switch the "active" window to a view that
-allows changing its geometry. One further hit on "w" switches the window to a
-view that allows changing its window-specific keybindings. The global
-keybindings may 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
-hitting the "F5", "F6" and "F7" keys.
-
-What actions are available globally or only in specific windows can be further
-manipulated by editing the files config/keybindings_global and
-config/windows/Win_* that map keycodes to commands to the respective keybinding
-repositories. While keybindings_global contains merely a list of keycode command
-mappings, the Win_* files start with the name of the windows to be configured,
-followed by a one-character line for internal use (mapping the window to one of
-several internally available window content drawing functions), followed by two
-lines describing the window's designated height and width, and only then an
-optional list of keybindings specific to that window.
-
-Replay game recording
----------------------
-
-Run "./roguelike -s" to watch a recording of the current game from the
-beginning. Hit the "next turn / wait" key to increment turns. Keys to
-manage windows, scroll on the map and quit the program are active; keys
-to perform player actions are inactive. Append a number to the -s option
-(like "-s100") to start the recording at the respective turn number.
+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
+
+Save files, replay game recording, starting over
+------------------------------------------------
+
+By default, the game state is saved in the file ./save, and read from there on
+(server) restart. Another file name to use can be given with the -l option (i.e.
+start the game with "./roguelike -l alternate_savefile"). To start over in a new
+world, remove ./save, or use the -l option with the name of a file that does not
+exist yet.
+
+Once you start a new world, every game action of yours is appended to a file
+called "record_" plus the save file name. Run "./roguelike -s" to watch the
+current game's recording from the beginning. Hit any player action key to
+increment turns (they will not trigger the actions usually mapped to them, only
+repeat the actions done at that point in the game as defined in the record
+file). Keys to manage windows, scroll on the map and quit the program do their
+usual thing. Append a number to the -s option (like "-s100") to start the
+recording playback at the respective turn number. (Don't forget to delete /
+empty a game's record file when deleting its save file, or different game's
+moves will get mixed up in one record file.)
+
+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
+./SERVER_COMMANDS. The server usually reads these from the files ./server/in
+(written to by ./roguelike-client), ./confserver/world, ./record_save and
+./save.
+
+All source files are thoroughly documented to explain more details of the
+PlomRogue engine's internals. The ./roguelike-server executable can be run with
+a -v option for helpful debugging info (mostly: what messages the client sends
+to the server). Server and client communicate via files in the ./server/
+directory (generated when the server is first run). The ./server/in file is read
+by the server for newline-delimited commands. The ./server/out file contains
+server messages to be read by clients. The ./server/worldstate file contains a
+serialized representation of the game world's data as it is to be visible to
+the player / the player's client.
projects / plomrogue / blobdiff