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. If no enemy is found in their surroundings,
  16 they just wait.
  17
  18 Once you start a new world, every move of yours is recorded in a file called
  19 "record". Once you re-start the game, all of your previous moves are replayed
  20 automatically up to the point wherere you left the game. To start over in a new
  21 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 Do the following steps:
  28
  29 $ git clone https://github.com/plomlompom/plomrogue
  30 $ cd plomrogue
  31 $ make
  32 $ ./roguelike
  33
  34 (It may also work on other Unix-like systems with ncurses, who knows.)
  35
  36 Make generates two executables ./roguelike-server and ./roguelike-client.
  37 ./roguelike is a pre-existing shell script that merely executes both of them,
  38 with the server as a background job. You can also ignore the script and start
  39 the two by hand.
  40
  41 Client's keybindings and window management
  42 ------------------------------------------
  43
  44 In the client's default window configuration, the window appearing on the left
  45 sports a list of keybindings available globally, and additionally via the window
  46 selected as active.
  47
  48 Hit "W" (per default keybindings) to switch the "active" window to a view that
  49 allows changing its geometry. One more hit on "w" switches the window to a view
  50 that allows changing its window-specific keybindings. The global keybindings can
  51 be changed in the "Global keys" window, those of the window geometry
  52 configuration in the "Window geometry keys" window, and those of the
  53 window-specific keybindings configuration in the "Window keybinding keys"
  54 window; by default, these three windows are not visible, but may be turned on by
  55 (per default keybindings) hitting the "F6", "F7" and "F8" keys.
  56
  57 Keybindings and default window selection / visibilities / geometries are read
  58 from the textfile ./confclient/interface_conf by default, or by another one
  59 named by the -i command line option of the client. Some other default window
  60 configurations are stored below ./confclient/single_windows/: "map", "info",
  61 "inventory" and "log". Each of these opens up only a single window into the
  62 client, filling up the entire terminal. This may be useful for running multiple
  63 clients in parallel in multiple terminal windows that can be managed by one's
  64 own window manager choice, instead of relying on plomrogue-client's bizarre
  65 in-client window management.
  66
  67 Replay game recording
  68 ---------------------
  69
  70 Run "./roguelike -s" to watch a recording of the current game from the
  71 beginning. Hit any player action key to increment turns (they will not trigger
  72 the actions usually mapped to them, only repeat the actions done at that point
  73 in the game as defined in the "record" file). Keys to manage windows, scroll on
  74 the map and quit the program do their usual thing. Append a number to the -s
  75 option (like "-s100") to start the recording at the respective turn number.
  76
  77 Hacking / server internals and configuration
  78 --------------------------------------------
  79
  80 The ./confserver/world file defines the map object types, actions available to
  81 them and the map itself. Each definition consists of a multi-line block wherein
  82 each line sets one attribute of the object type, action or the map.
  83
  84 Here's a typical map definition block:
  85
  86 MAP_TYPE 0
  87 HEIGHT 64
  88 WIDTH 64
  89
  90 A line of "MAP_TYPE" followed by a non-empty token starts the map definition
  91 block. In the future, the second token may differentiate different map types,
  92 but as of right now, only one is available and the value is not interpreted.
  93 The numbers after "HEIGHT" and "WIDTH" give the map's vertical and horizontal
  94 extensions in cells. They must be >= 1 and <= 256.
  95
  96 Here's a typical action definition block:
  97
  98 ACTION 1
  99 NAME move
 100 EFFORT 5
 101
 102 A line of "ACTION" followed by a number starts an action definition block and
 103 sets the action's id (must be > 0) for internal use to 1. The number after
 104 "EFFORT" determines how many turns this action takes for the actor performing
 105 it. The string after "NAME" names the action. Furthermore, if it is one of
 106 "move", "pick_up", "drop" or "use", it matches internal functions described by
 107 these strings to this action. All other names (including "wait") currently are
 108 matched to a do-nothing wait function.
 109
 110 Here's a typical map object type definition block:
 111
 112 OBJECT 2
 113 NAME ZOMBIE
 114 SYMBOL z
 115 LIFEPOINTS 3
 116 CORPSE_ID 5
 117 CONSUMABLE 0
 118 START_NUMBER 9
 119
 120 A line of "OBJECT" followed by a number starts it, and the number sets the
 121 object type's internal id. The number after "CONSUMABLE" defines the object
 122 as consumable (and to so many hitpoints gain). The character after "SYMBOL" is
 123 the one shown on the map to represent to object type. "LIFEPOINTS" is the start
 124 hitpoints value for this object type and defines it as animate if it is
 125 non-zero. The string after "NAME" sets the object type's name. "CORPSE_ID" sets
 126 the id of the object type that objects of this type degrade to if their
 127 hitpoints drop to zero if they start out as inanimate (what is not implemented
 128 yet: or if they are inanimate, but are otherwise crushed). Note that the
 129 "CORPSE_ID" must match the id of an object type defined in the file (before or
 130 after, it may even be the same). "START_NUMBER" sets the number of objects that
 131 are to appear of the given type on the map on game start.
 132
 133 All these definition block members must be present within their blocks, but only
 134 "ACTION" / "OBJECT" / "MAP_TYPE" must be positioned at their respective blocks'
 135 first line; the others may appear in whatever order and even multiple times. If
 136 an object or action definition block is finished, however, it cannot be
 137 re-defined by starting a new block with the same object type or action id.
 138
 139 Tokens in this config file are separated by whitespace. Single quotes can be
 140 put around string values that are to include whitespace by themslves. Note that
 141 all numbers must be decimal representations of unsigned 8 bit integers, i.e.
 142 >= 0 and < 256 and sans preceding "+".
 143
 144 All source files are thoroughly documented to explain more details of
 145 plomrogue's internals. The ./roguelike-server executable can be run with a -v
 146 option for helpful debugging info (mostly: what messages the client sends to the
 147 server). Server and client communicate via files in the ./server/ directory
 148 (generated when the server is first run). The ./server/in file is read by the
 149 server for newline-delimited commands. The ./server/out file contains server
 150 messages to be read by clients. The ./server/worldstate file contains a
 151 serialized representation of the game world's data as it is to be visible to
 152 the player / the player's client.