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 there are insanely ambitious long-term plans).
   6
   7 You can move around a player on an island and meet a number of different
   8 enemies. You have 5 hitpoints to lose before death; they start with different
   9 amounts of hitpoints, depending on their species. Your score grows by killing
  10 enemies, to the amount of hitpoints each killed enemy started with. Dead enemies
  11 become dirt, skeletons or "magic meat"--such objects can be collected, and
  12 "magic meat" can be consumed to gain hitpoints. Note that different kinds of
  13 movements/actions take different numbers of turns to finish.
  14
  15 Enemies' AI is very dumb so far: Each turn, they try to move in the (beeline)
  16 direction of the nearest enemy, so they often bump into, and get stuck behind,
  17 obstacles. You can use that for your advantage.
  18
  19 Once you start a new world, every move of yours is recorded in a file called
  20 "record". Once you re-start the game, all of your previous moves are replayed
  21 automatially until you end up where you left the game. To start over in a new
  22 world, 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 Perform the following steps:
  29
  30 $ git clone https://github.com/plomlompom/plomrogue
  31 $ cd plomrogue
  32 $ make
  33 $ ./roguelike
  34
  35 (It might also work on other Unix-like systems with ncurses, who knows.)
  36
  37 Note that make generates two executables ./roguelike-server and
  38 ./roguelike-client. ./roguelike is a pre-existing shell script that merely
  39 executes both of them, with the server as a background job. You may also
  40 ignore the script and start the two by hand.
  41
  42 Client's keybindings and window management
  43 ------------------------------------------
  44
  45 In the client's default window configuration, the window appearing on the left
  46 sports a list of keybindings available globally, and additionally via the window
  47 currently selected as active.
  48
  49 Hit "w" (per default keybindings) to switch the "active" window to a view that
  50 allows changing its geometry. One further hit on "w" switches the window to a
  51 view that allows changing its window-specific keybindings. The global
  52 keybindings may be changed in the "Global keys" window, those of the window
  53 geometry configuration in the "Window geometry keys" window, and those of the
  54 window-specific keybindings configuration in the "Window keybinding keys"
  55 window; by default, these three windows are not visible, but may be turned on by
  56 hitting the "F6", "F7" and "F8" keys.
  57
  58 What actions are available globally or only in specific windows can be further
  59 manipulated by editing the files ./confclient/keybindings_global and
  60 ./confclient/windows/Win_* that map keycodes to commands to the respective
  61 keybinding repositories. While keybindings_global contains merely a list of
  62 keycode command mappings, the Win_* files start with the name of the windows to
  63 be configured, followed by a one-character line for internal use (mapping the
  64 window to one of several internally available window content drawing functions),
  65 followed by two lines describing the window's designated height and width, and
  66 only then an optional list of keybindings specific to that window.
  67
  68 Replay game recording
  69 ---------------------
  70
  71 Run "./roguelike -s" to watch a recording of the current game from the
  72 beginning. Hit any player action key to increment turns (they will not trigger
  73 the actions usually mapped to them, only repeat the actions performed at that
  74 point in the game as defined in the "record" file). Keys to manage windows,
  75 scroll on the map and quit the program do their usual thing. Append a number to
  76 the -s option (like "-s100") to start the recording at the respective turn
  77 number.
  78
  79 Hacking / server internals and configuration
  80 --------------------------------------------
  81
  82 The movements/actions available to the player and the enemies are defined and
  83 can be changed in ./confserver/map_object_actions. Each line consists of, first,
  84 a numerical ID used internally to manage the action, secondly the number of
  85 turns the action takes, and thirdly a string representing the action internally.
  86
  87 The different map object types, i.e. species (including the player's human one)
  88 and item types, can be edited in ./confserver/defs. Here the first value is a
  89 numerical ID that represents the object type, the second one describes what type
  90 this object decomposes to when it gets destroyed/killed, the third value is the
  91 character used to represent the object visually on the map, the fourth value is
  92 the number of hitpoints the object starts with (items are dead and start with
  93 zero hitpoints, anything else moves), the fifth is the string that names the
  94 object in the game log. Note that the only valid item use so far, consuming
  95 "magic meat" to gain hitpoints, is so far hard-coded (this should change in the
  96 future).
  97
  98 All source files are thoroughly documented to explain more details of
  99 plomrogue's internals. The ./roguelike-server executable can be run with a -v
 100 option for helpful debugging info (mostly: what messages the client sends to the
 101 server). Server and client communicate via files in the ./server/ directory
 102 (generated when the server is first run). The /server/in fifo receives commands
 103 for the server as null-terminated strings. The /server/out file contains a
 104 serialized representation of the game world's data as it is to be available to
 105 the player / the player's client.