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