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