plomlompom.com Git - plomrogue/blob - README

   1 7DRL 2015 project: Please the Island God
   2 ========================================
   3
   4 Description
   5 -----------
   6
   7 See <http://www.plomlompom.de/PlomRogue/plomwiki.php?title=7DRL2015Day2>
   8 and <http://www.plomlompom.de/PlomRogue/plomwiki.php?title=7DRL2015Day3>.
   9
  10 System requirements / installation / running the game
  11 -----------------------------------------------------
  12
  13 The game is expected to run:
  14 - on Unix systems with a vt100-like terminal environment (xterm will do)
  15 - that contain the ncurses library
  16 - and Python3 (version >= 3.2.3).
  17
  18 To build it, this is furthermore necessary:
  19 - gcc (version >= 4.7.2); some llvm masked as gcc was tested successfully on OSX
  20 - libc library headers (libc6-dev?)
  21 - ncurses library headers (libncurses5-dev?)
  22
  23 To build and start, do the following steps:
  24
  25 $ ./redo
  26 $ ./roguelike
  27
  28 (If you got a version of djb's redo build system installed and in your $PATH,
  29 you could also do a simple "redo" instead of "./redo". The ./redo script calls a
  30 simple partial shell script implementation of redo stored below
  31 ./build/redo_scripts/, written by Nils Dagsson Moskopp a.k.a. erlehmann.)
  32
  33 There are two executables ./roguelike-server and ./roguelike-client.
  34 ./roguelike is a pre-existing shell script that merely executes both of them,
  35 with the server as a background job. You can also ignore the script and start
  36 any of the two by hand.
  37
  38 Keybindings
  39 -----------
  40
  41 a - let AI decide move
  42
  43 w - move north-west
  44 e - move north-east
  45 s - move west
  46 d - move east
  47 x - move south-west
  48 c - move south-east
  49
  50 w - wait one turn
  51
  52 l - toggle "look" mode, investigate map cells by moving a cursor over the map
  53     instead of the player avatar
  54
  55 p - pick up item
  56 D - drop item selected in inventory
  57 u - use item selected in inventory
  58
  59 UP - navigate upwards in Inventory
  60 DOWN - navigate downwards in inventory
  61
  62 Save files, replay game recording, starting over
  63 ------------------------------------------------
  64
  65 By default, the game state is saved in the file ./save, and read from there on
  66 (server) restart. Another file name to use can be given with the -l option (i.e.
  67 start the game with "./roguelike -l alternate_savefile"). To start over in a new
  68 world, remove ./save, or use the -l option with the name of a file that does not
  69 exist yet.
  70
  71 Once you start a new world, every game action of yours is appended to a file
  72 called "record_" plus the save file name. Run "./roguelike -s" to watch the
  73 current game's recording from the beginning. Hit any player action key to
  74 increment turns (they will not trigger the actions usually mapped to them, only
  75 repeat the actions done at that point in the game as defined in the record
  76 file). Keys to manage windows, scroll on the map and quit the program do their
  77 usual thing. Append a number to the -s option (like "-s100") to start the
  78 recording playback at the respective turn number. (Don't forget to delete /
  79 empty a game's record file when deleting its save file, or different game's
  80 moves will get mixed up in one record file.)
  81
  82 Hacking / server internals and configuration
  83 --------------------------------------------
  84
  85 The game world is set up and made subject to player commands by
  86 ./roguelike-server. It's controlled by commands explained in the file
  87 ./SERVER_COMMANDS. The server usually reads these from the files ./server/in
  88 (written to by ./roguelike-client), ./confserver/world, ./record_save and
  89 ./save.
  90
  91 All source files are thoroughly documented to explain more details of the
  92 PlomRogue engine's internals. The ./roguelike-server executable can be run with
  93 a -v option for helpful debugging info (mostly: what messages the client sends
  94 to the server). Server and client communicate via files in the ./server/
  95 directory (generated when the server is first run). The ./server/in file is read
  96 by the server for newline-delimited commands. The ./server/out file contains
  97 server messages to be read by clients. The ./server/worldstate file contains a
  98 serialized representation of the game world's data as it is to be visible to
  99 the player / the player's client.