X-Git-Url: https://plomlompom.com/repos/foo.html?a=blobdiff_plain;f=README;h=14115722c4043bd46756d976a8c4694266b413ce;hb=436d36515ec10f31ab89e6867f59023177f560a2;hp=6ad1207c55ae067a81189d3a642eb902155e0ad1;hpb=e505542d10413b5cf94edda90bdc793a48db9385;p=plomrogue diff --git a/README b/README index 6ad1207..1411572 100644 --- a/README +++ b/README @@ -1,73 +1,92 @@ -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 some ncurses windows in a bizarre -fashion. +Description +----------- + +See +and . + +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). -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 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?) -The map get generated randomly, too. +To build and start, do the following steps: -There is only one save file (named "savefile"), and it gets overwritten -each new turn. To start over with a new world, delete it. +$ ./redo +$ ./roguelike -Install/run +(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.) + +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 - -Default keybindings -------------------- - -Q quit -F1 toggle keybinding editing window -F2 toggle map window -F3 toggle info window -F4 toggle log window - -LEFT scroll windows pad left -RIGHT scroll windows pad right -> cycle window selection forwards -< cycle window selection backwards -y shift window forwards -Y shift window backwards -* grow window horizontally -_ shrink window horizontally -+ grow window vertically -- shrink window vertically -Z reload window configuration - -w scroll map up -x scroll map down -a scroll map left -d scroll map right -s center map on player -W move player up -X move player down -A move player left -D move player right -S next turn / wait - -K save current keybindings -UP navigate selection upwards in keybinding editing window -DOWN navigate selection downwards in keybinding editing window -RETURN modify keybinding selected in keybinding editing window +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 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. +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 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 +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.