X-Git-Url: https://plomlompom.com/repos/foo.html?a=blobdiff_plain;f=README;h=14115722c4043bd46756d976a8c4694266b413ce;hb=436d36515ec10f31ab89e6867f59023177f560a2;hp=5f1be55ae5788963aac9a1f5cf7ad6b8df19ca36;hpb=9e85c433c4c33c18e08f73c1b46f8f92ec939f14;p=plomrogue diff --git a/README b/README index 5f1be55..1411572 100644 --- a/README +++ b/README @@ -1,101 +1,85 @@ -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. If no enemy is found in their surroundings, -they just wait. - -Diagonal movement is possible, but takes (40%) longer than orthogonal movement. - -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 -automatically up to the point wherere you left the game. 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. -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). -$ git clone https://github.com/plomlompom/plomrogue -$ cd plomrogue -$ make +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: + +$ ./redo $ ./roguelike -(It may also work on other Unix-like systems with ncurses, who knows.) +(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.) -Make 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 --------------------- -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 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 at the respective turn number. +Once you start a new world, every move of yours is recorded in a file called +"record_save". It gets overwritten when a new game world is started after +deletion of the "save" file. 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 theactions +done at that point in the game as defined in the "record_save" 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. 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 entry consists of a -first line of a numerical ID used internally to uniquely identify and manage the -action, a second line of the number of turns the action takes, and a third line -of a string that maps the action to the game logic to do when it is called. -Finally, a delimiter line of "%%" ends the entry. - -The different map object types, i.e. species (including the player's human one) -and item types, can be edited in ./confserver/map_objects. 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 ASCII 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, the sixth defines if the object is consumable -(it is if it is non-zero) and how many hitpoints are gained if it is. Finally, -the same delimiter as for the map object action definitions file follows. +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 plomrogue's internals. The ./roguelike-server executable can be run with a -v