plomrogue
=========
-plomlompom tries to build his own roguelike. It doesn't do much yet (although
-there are insanely ambitious long-term plans).
-
-You can move around a player on an island and meet a number of different
-enemies. You have 5 hitpoints to lose before death; they start with different
-amounts of hitpoints, depending on their species. Your score grows by killing
-enemies, to the amount of hitpoints each killed enemy started with. 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 in the (beeline)
-direction of the nearest enemy, so they often bump into, and get stuck behind,
-obstacles. You can use that for your advantage.
-
-Once you start a new world, every move of yours is recorded in a file called
-"record". Once you re-start the game, all of your previous moves are replayed
-automatially until you end up where you left the game. To start over in a new
-world, delete this file.
+plomlompom tries to build his own roguelike engine. There is one game for it so
+far, which is loaded by default: "Please the Island God". See ./README_PtIG for
+details on it.
System requirements / installation / running the game
-----------------------------------------------------
-The game is expected to run on Linux systems that contain the ncurses library.
-Perform the following steps:
+The engine 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?)
+
+To build and start it with the default game, just run:
-$ git clone https://github.com/plomlompom/plomrogue
-$ cd plomrogue
-$ make
$ ./roguelike
-(It might also work on other Unix-like systems with ncurses, who knows.)
-
-Note that make generates 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 may 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
-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 "F6", "F7" and "F8" keys.
-
-What actions are available globally or only in specific windows can be further
-manipulated by editing the files confclient/keybindings_global and
-confclient/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 any player action key to increment turns (they will not trigger
-the actions usually mapped to them, only repeat the actions performed 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 at the respective turn
-number.
+./roguelike is a shell script that executes a union of ./roguelike-server and
+./roguelike-client, with the server as a background job. You may ignore the
+script and start either or both of the two by hand if you please.
+
+Save files, replay game recording, starting over
+------------------------------------------------
+
+Every move of yours re-writes a file "save" that describes the new state of the
+world, if more than 15 seconds have passed since its last writing. Once you
+re-start plomrogue, the game state is recreated from the "save" file. To start
+over in a new world, simply delete this file and re-start the engine.
+
+The save file is called ./save be default, but another file name to use can be
+given with the -l option (i.e. start the game with "./roguelike -l
+alternate_savefile"). The -l option can also be used to start over in a new
+world whose state will be read and saved with the alternate file path, without
+overwriting other games saved in other save files.
+
+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). Other keys 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 movements/actions available to the player and the enemies are defined and
-can be changed in ./confserver/map_object_actions. Each line consists of, first,
-a numerical ID used internally to manage the action, secondly the number of
-turns the action takes, and thirdly a string representing the action internally.
-
-The different map object types, i.e. species (including the player's human one)
-and item types, can be edited in ./confserver/defs. Here the first value is a
-numerical ID that represents the object type, the second one describes what type
-this object decomposes to when it gets destroyed/killed, the third value is the
-character used to represent the object visually on the map, the fourth value is
-the number of hitpoints the object starts with (items are dead and start with
-zero hitpoints, anything else moves), the fifth is the string that names the
-object in the game log. Note that the only valid item use so far, consuming
-"magic meat" to gain hitpoints, is so far hard-coded (this should change in the
-future).
-
-All source files are thoroughly documented to explain more details of
-plomrogue'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 fifo receives commands
-for the server as null-terminated strings. The /server/out file contains a
-serialized representation of the game world's data as it is to be available to
-the player / the player's client.
+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_run/in
+(written to by ./roguelike-client), ./confserver/world, ./record_save and
+./save.
+
+The ./roguelike-server executable can be run with a -v option for possibly
+helpful debugging info (mostly: what messages the client sends to the server).
+
+Server and client communicate via files in the ./server_run/ directory
+(generated when the server is first run). The ./server_run/in file is read by
+the server for newline-delimited commands. The ./server_run/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