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 Diagonal movement is possible, but takes (40%) longer than orthogonal movement.
  19
  20 Once you start a new world, every move of yours is recorded in a file called
  21 "record". Once you re-start the game, all of your previous moves are replayed
  22 automatically up to the point wherere you left the game. To start over in a new
  23 world, simply delete this file.
  24
  25 System requirements / installation / running the game
  26 -----------------------------------------------------
  27
  28 The game is expected to run on Linux systems that contain the ncurses library.
  29 Do the following steps:
  30
  31 $ git clone https://github.com/plomlompom/plomrogue
  32 $ cd plomrogue
  33 $ make
  34 $ ./roguelike
  35
  36 (It may also work on other Unix-like systems with ncurses, who knows.)
  37
  38 Make generates two executables ./roguelike-server and ./roguelike-client.
  39 ./roguelike is a pre-existing shell script that merely executes both of them,
  40 with the server as a background job. You can also ignore the script and start
  41 the two by hand.
  42
  43 Client's keybindings and window management
  44 ------------------------------------------
  45
  46 In the client's default window configuration, the window appearing on the left
  47 sports a list of keybindings available globally, and additionally via the window
  48 selected as active.
  49
  50 Hit "w" (per default keybindings) to switch the "active" window to a view that
  51 allows changing its geometry. One more hit on "w" switches the window to a view
  52 that allows changing its window-specific keybindings. The global keybindings can
  53 be changed in the "Global keys" window, those of the window geometry
  54 configuration in the "Window geometry keys" window, and those of the
  55 window-specific keybindings configuration in the "Window keybinding keys"
  56 window; by default, these three windows are not visible, but may be turned on by
  57 (per default keybindings) hitting the "F6", "F7" and "F8" keys.
  58
  59 Keybindings and default window selection / visibilities / geometries are read
  60 from the textfile ./confclient/interface_conf by default, or by another one
  61 named by the -i command line option of the client. Some other default window
  62 configurations are stored below ./confclient/single_windows/: "map", "info",
  63 "inventory" and "log". Each of these opens up only a single window into the
  64 client, filling up the entire terminal. This may be useful for running multiple
  65 clients in parallel in multiple terminal windows that can be managed by one's
  66 own window manager choice, instead of relying on plomrogue-client's bizarre
  67 in-client window management.
  68
  69 Replay game recording
  70 ---------------------
  71
  72 Run "./roguelike -s" to watch a recording of the current game from the
  73 beginning. Hit any player action key to increment turns (they will not trigger
  74 the actions usually mapped to them, only repeat the actions done at that point
  75 in the game as defined in the "record" file). Keys to manage windows, scroll on
  76 the map and quit the program do their usual thing. Append a number to the -s
  77 option (like "-s100") to start the recording at the respective turn number.
  78
  79 Hacking / server internals and configuration
  80 --------------------------------------------
  81
  82 The ./confserver/world file defines the map object types and the actions
  83 available to them. Each object type and action is defined by a multi-line block
  84 wherein each line sets one attribute of the object type or action.
  85
  86 Here's a typical action definition block:
  87
  88 ACTION 1
  89 NAME move
  90 EFFORT 5
  91
  92 A line of "ACTION" followed by a number starts an action definition block and
  93 sets the action's id for internal use to 1. The number after "EFFORT" determines
  94 how many turns this action takes for the actor performing it. The string after
  95 "NAME" names the action. Furthermore, if it is one of "move", "pick_up", "drop"
  96 or "use", it matches internal functions described by these strings to this
  97 action. All other names (including "wait") currently are matched to a do-nothing
  98 wait function.
  99
 100 Here's a typical map object type definition block:
 101
 102 OBJECT 2
 103 NAME ZOMBIE
 104 SYMBOL z
 105 LIFEPOINTS 3
 106 CORPSE_ID 5
 107 CONSUMABLE 0
 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).
 120
 121 All this definition block members must be present within a block, but only
 122 "ACTION" / "OBJECT" must be positioned at the respective blocks' first line,
 123 the others may appear in whatever order and even multiple times. If a block is
 124 finished, however, it cannot be re-defined by starting a new block wit the same
 125 object type or action id. Tokens in this config file are separated by
 126 whitespace. Single quotes can be put around string values that are to include
 127 whitespace by themslves.
 128
 129 All source files are thoroughly documented to explain more details of
 130 plomrogue's internals. The ./roguelike-server executable can be run with a -v
 131 option for helpful debugging info (mostly: what messages the client sends to the
 132 server). Server and client communicate via files in the ./server/ directory
 133 (generated when the server is first run). The ./server/in file is read by the
 134 server for newline-delimited commands. The ./server/out file contains server
 135 messages to be read by clients. The ./server/worldstate file contains a
 136 serialized representation of the game world's data as it is to be visible to
 137 the player / the player's client.