plomlompom.com Git - plomrogue/blob - README

   1 plomrogue
   2 =========
   3
   4 plomlompom tries to build his own roguelike. Currently, it doesn't do much
   5 interesting, apart from managing keybindings and some ncurses windows in a
   6 bizarre fashion.
   7
   8 You can move around a player and meet a number of different enemies. They move
   9 randomly and will only accidentally hit you. You have 5 hitpoints to lose before
  10 death; they have either 1, 3 or 9. Your score grows by killing enemies, to the
  11 amount of hitpoints each killed enemy started with. Dead enemies become dirt,
  12 skeletons or "magic meat"--such objects can be collected, and "magic meat" can
  13 be consumed to gain hitpoints.
  14
  15 The map gets generated randomly, too.
  16
  17 There is only one save file (named "savefile"), and it gets overwritten each new
  18 turn. To start over with a new world, delete it.
  19
  20 Install/run
  21 -----------
  22
  23 Dependencies: the ncurses library.
  24
  25 git clone https://github.com/plomlompom/plomrogue
  26 cd plomrogue
  27 make
  28 ./roguelike
  29
  30 Keybindings and window configuration
  31 ------------------------------------
  32
  33 In the default window configuration, the window appearing on the left sports a
  34 list of keybindings available globally and additionally via the window currently
  35 selected as active.
  36
  37 Hit "w" (per default keybindings) to switch the "active" window to a view that
  38 allows changing its geometry. One further hit on "w" switches the window to a
  39 view that allows changing its window-specific keybindings. The global
  40 keybindings may be changed in the "Global keys" window, those of the window
  41 geometry configuration in the "Window geometry keys" window" and those of the
  42 window-specific keybindings configuration in the "Window keybinding keys"
  43 window; by default, these three windows are not visible, but may be turned on by
  44 hitting the "F5", "F6" and "F7" keys.
  45
  46 What actions are available globally or only in specific windows can be further
  47 manipulated by editing the files config/keybindings_global and
  48 config/windows/Win_* that map keycodes to commands to the respective keybinding
  49 repositories. While keybindings_global contains merely a list of keycode command
  50 mappings, the Win_* files start with the name of the windows to be configured,
  51 followed by a one-character line for internal use (mapping the window to one of
  52 several internally available window content drawing functions), followed by two
  53 lines describing the window's designated height and width, and only then an
  54 optional list of keybindings specific to that window.
  55
  56 Replay game recording
  57 ---------------------
  58
  59 Run "./roguelike -s" to watch a recording of the current game from the
  60 beginning. Hit the "next turn / wait" key to increment turns. Keys to
  61 manage windows, scroll on the map and quit the program are active; keys
  62 to perform player actions are inactive. Append a number to the -s option
  63 (like "-s100") to start the recording at the respective turn number.