plomlompom.com Git - plomrogue/blob - README

   1 plomrogue
   2 =========
   3
   4 plomlompom tries to build his own roguelike. It doesn't do much yet (although
   5 plomlompom has insanely ambitious long-term plans).
   6
   7 You can move around a player on an island and meet different enemies. You have 5
   8 hitpoints to lose before death. Enemies start with different amounts of
   9 hitpoints, depending on their species. Dead enemies become dirt, skeletons or
  10 "magic meat" -- such objects can be collected, and "magic meat" can be consumed
  11 to gain hitpoints. Note that different kinds of movements/actions take different
  12 numbers of turns to finish.
  13
  14 Enemies' AI is very dumb so far: Each turn, they try to move towards their
  15 shortest-path-wise nearest enemy visible to them. If they see no enemy, they
  16 just wait.
  17
  18 Every move of yours re-writes a file "savefile" that describes the new state of
  19 the world. Once you re-start the game, the game state is recreated from the
  20 "savefile" file. To start over in a new world, simply delete this file.
  21
  22 System requirements / installation / running the game
  23 -----------------------------------------------------
  24
  25 The game is expected to run on Linux systems that contain the ncurses library.
  26 (It may also work on other Unix-like systems with ncurses, who knows.) Do the
  27 following steps:
  28
  29 $ git clone https://github.com/plomlompom/plomrogue
  30 $ cd plomrogue
  31 $ ./redo
  32 $ ./roguelike
  33
  34 (If you got a redo build system installed and in your $PATH, you could also do a
  35 simple "redo" instead of "./redo". The ./redo script calls a simple partial
  36 shell script implementation of redo stored below build/redo_scripts/, written by
  37 Nils Dagsson Moskopp a.k.a. erlehmann.)
  38
  39 ./redo generates two executables ./roguelike-server and ./roguelike-client.
  40 ./roguelike is a pre-existing shell script that merely executes both of them,
  41 with the server as a background job. You can also ignore the script and start
  42 the two by hand.
  43
  44 Client's keybindings and window management
  45 ------------------------------------------
  46
  47 In the client's default window configuration, the window appearing on the left
  48 sports a list of keybindings available globally, and additionally via the window
  49 selected as active.
  50
  51 Hit "W" (per default keybindings) to switch the "active" window to a view that
  52 allows changing its geometry. One more hit on "W" switches the window to a view
  53 that allows changing its window-specific keybindings. The global keybindings can
  54 be changed in the "Global keys" window, those of the window geometry
  55 configuration in the "Window geometry keys" window, and those of the
  56 window-specific keybindings configuration in the "Window keybinding keys"
  57 window; by default, these three windows are not visible, but may be turned on by
  58 (per default keybindings) hitting the "F6", "F7" and "F8" keys.
  59
  60 Keybindings and default window selection / visibilities / geometries are read
  61 from the textfile ./confclient/interface_conf by default, or by another one
  62 named by the -i command line option of the client. Some other default window
  63 configurations are stored below ./confclient/single_windows/: "map", "info",
  64 "inventory" and "log". Each of these opens up only a single window into the
  65 client, filling up the entire terminal. This may be useful for running multiple
  66 clients in parallel in multiple terminal windows that can be managed by one's
  67 own window manager choice, instead of relying on plomrogue-client's bizarre
  68 in-client window management.
  69
  70 Replay game recording
  71 ---------------------
  72
  73 Once you start a new world, every move of yours is recorded in a file called
  74 "record". It gets overwritten when a new game world is started after deletion
  75 of the "savefile" file. Run "./roguelike -s" to watch the current game's
  76 recording from the beginning. Hit any player action key to increment turns (they
  77 will not trigger the actions usually mapped to them, only repeat the actions
  78 done at that point in the game as defined in the "record" file). Keys to manage
  79 windows, scroll on the map and quit the program do their usual thing. Append a
  80 number to the -s option (like "-s100") to start the recording at the respective
  81 turn number.
  82
  83 Hacking / server internals and configuration
  84 --------------------------------------------
  85
  86 The game world is set up and made subject to player commands by
  87 ./roguelike-server. It's controlled by commands explained in the file …
  88 The server usually reads these from the files ./server/in (written to by
  89 ./roguelike-client), ./confserver/world, ./record and ./savefile. See the file
  90 ./SERVER_COMMANDS for details.
  91
  92 All source files are thoroughly documented to explain more details of
  93 plomrogue's internals. The ./roguelike-server executable can be run with a -v
  94 option for helpful debugging info (mostly: what messages the client sends to the
  95 server). Server and client communicate via files in the ./server/ directory
  96 (generated when the server is first run). The ./server/in file is read by the
  97 server for newline-delimited commands. The ./server/out file contains server
  98 messages to be read by clients. The ./server/worldstate file contains a
  99 serialized representation of the game world's data as it is to be visible to
 100 the player / the player's client.