X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=README;h=8a73d7f7e36276e88bd41c839d2ca2f7e80cf4f4;hb=550d22ec0c3f530f5d317746f3f7e75251a1de4b;hp=9f80b0456b54b03d322d5aa7c253a17a450d31cb;hpb=b4bb10b6e9089bd267a513dbf37543c318b5eb1e;p=plomrogue

diff --git a/README b/README
index 9f80b04..8a73d7f 100644
--- a/README
+++ b/README
@@ -1,15 +1,19 @@
 plomrogue
 =========
 
-plomlompom tries to build his own roguelike. Currently, it doesn't do
-much interesting, apart from managing some ncurses windows in a bizarre
-fashion. You can move around a player and meet a random number enemies;
-they will occasionally hit you on contact, but without consequence to
-you: The player has no hitpoints so far. Enemies have 5 hitpoints at
-start and disappear if their hitpoints reach 0. The map gets generated
-randomly, too. There is only one save file (named "savefile"), and it
-gets overwritten each new turn. To start over with a new world, delete
-it.
+plomlompom tries to build his own roguelike. Currently, it doesn't do much
+interesting, apart from managing keybindings and some ncurses windows in a
+bizarre fashion.
+
+You can move around a player and meet a number of different enemies. They move
+randomly and will only accidentally hit you. You have 5 hitpoints to lose before
+death; they have either 1, 3 or 9. Your score grows by killing enemies, to the
+amount of hitpoints each killed enemy started with.
+
+The map get generated randomly, too.
+
+There is only one save file (named "savefile"), and it gets overwritten each new
+turn. To start over with a new world, delete it.
 
 Install/run
 -----------
@@ -21,40 +25,27 @@ cd plomrogue
 make
 ./roguelike
 
-Default keybindings
--------------------
-
-Q       quit
-F1      toggle keybinding editing window
-F2      toggle map window
-F3      toggle info window
-F4      toggle log window
-
-LEFT    scroll windows pad left
-RIGHT   scroll windows pad right
->       cycle window selection forwards
-<       cycle window selection backwards
-y       shift window forwards
-Y       shift window backwards
-*       grow window horizontally
-_       shrink window horizontally
-+       grow window vertically
--       shrink window vertically
-
-w       scroll map up
-x       scroll map down
-a       scroll map left
-d       scroll map right
-t       move player up
-b       move player down
-f       move player left
-h       move player rifght
-.       next turn / wait
-
-S       save current keybindings
-UP      navigate selection upwards in keybinding editing window
-DOWN    navigate selection downwards in keybinding editing window
-RETURN  modify keybinding selected in keybinding editing window
+Keybindings and window configuration
+------------------------------------
+
+In the default window configuration, globally available keybinings are shown at
+game start in the three windows on the left of the screen. The lower two windows
+describe keybindings / actions only available in a window's window configuration
+views -- hit "w" (per default keybindings) to switch the selected / "active"
+window to a view that allows changing its geometry. One further hit on "w"
+switches the window to a view that lists keybindings available specifically for
+that window -- such as for map scrolling actions in the "map" window. All
+keybindings can be changed.
+
+What actions are available globally or only in specific windows can be further
+manipulated by editing the files config/keybindings_global and
+config/windows/Win_* that map keycodes to commands to the respective keybinding
+repositories. While keybindings_global contains merely a list of keycode command
+mappings, the Win_* files start with the name of the windows to be configured,
+followed by a one-character line for internal use (mapping the window to one of
+several internally available window content drawing functions), followed by two
+lines describing the window's designated height and width, and only then an
+optional list of keybindings specific to that window.
 
 Replay game recording
 ---------------------