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