plomlompom.com Git - plomrogue/blob - README

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