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 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, the map geometry and the map object type (species) of the player. Each
  82 definition consists of a single- or multi-line block wherein each line sets one
  83 attribute.
  84
  85 Here's a typical action definition block:
  86
  87 ACTION 1
  88 NAME move
  89 EFFORT 5
  90
  91 A line of "ACTION" followed by a number starts an action definition block and
  92 sets the action's id (must be > 0) for internal use to 1. The number after
  93 "EFFORT" determines how many turns this action takes for the actor performing
  94 it. The string after "NAME" names the action. Furthermore, if it is one of
  95 "move", "pick_up", "drop" or "use", it matches internal functions described by
  96 these strings to this action. All other names (including "wait") currently are
  97 matched to a do-nothing wait function.
  98
  99 Here's a typical map object type definition block:
 100
 101 OBJECT 2
 102 NAME ZOMBIE
 103 SYMBOL z
 104 LIFEPOINTS 3
 105 CORPSE_ID 5
 106 CONSUMABLE 0
 107 START_NUMBER 9
 108
 109 A line of "OBJECT" followed by a number starts it, and the number sets the
 110 object type's internal id. The number after "CONSUMABLE" defines the object
 111 as consumable (and to so many hitpoints gain). The character after "SYMBOL" is
 112 the one shown on the map to represent to object type. "LIFEPOINTS" is the start
 113 hitpoints value for this object type and defines it as animate if it is
 114 non-zero. The string after "NAME" sets the object type's name. "CORPSE_ID" sets
 115 the id of the object type that objects of this type degrade to if their
 116 hitpoints drop to zero if they start out as inanimate (what is not implemented
 117 yet: or if they are inanimate, but are otherwise crushed). Note that the
 118 "CORPSE_ID" must match the id of an object type defined in the file (before or
 119 after, it may even be the same). "START_NUMBER" sets the number of objects that
 120 are to appear of the given type on the map on game start.
 121
 122 The map is defined by a single-line block. Its number value sets the map
 123 square's edge length. It must be >= 1 and <= 256:
 124
 125 MAP_LENGTH 64
 126
 127 The player type / species is also defined by a single line block. Its number
 128 value sets the player's creature's map object type by its id:
 129
 130 PLAYER_TYPE 0
 131
 132 All these definition block members must be present within their respective
 133 blocks, but only "ACTION" and "OBJECT" must be positioned at their respective
 134 blocks' first line; the others may appear in whatever order and even multiple
 135 times. If an object or action definition block is finished, however, it cannot
 136 be re-defined by starting a new block with the same object type or action id.
 137
 138 Tokens in this config file are separated by whitespace. Single quotes can be
 139 put around string values that are to include whitespace by themslves. Note that
 140 all numbers must be decimal representations of unsigned 8 bit integers, i.e.
 141 >= 0 and < 256 and sans preceding "+".
 142
 143 All source files are thoroughly documented to explain more details of
 144 plomrogue's internals. The ./roguelike-server executable can be run with a -v
 145 option for helpful debugging info (mostly: what messages the client sends to the
 146 server). Server and client communicate via files in the ./server/ directory
 147 (generated when the server is first run). The ./server/in file is read by the
 148 server for newline-delimited commands. The ./server/out file contains server
 149 messages to be read by clients. The ./server/worldstate file contains a
 150 serialized representation of the game world's data as it is to be visible to
 151 the player / the player's client.