X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=README;h=25c1736c2df75a25c46fb9e3539f1708cc8aec79;hb=dabae638d8facb5b6f3923b42a894d40a090b3fe;hp=dfbdf0bf29423775fa5192ae9d694cea908ba5d4;hpb=310b07eb71dae03b1fdc60cc649a81afedea7d27;p=plomrogue diff --git a/README b/README index dfbdf0b..25c1736 100644 --- a/README +++ b/README @@ -8,16 +8,18 @@ You can move around a player on an island and meet different enemies. You have 5 hitpoints to lose before death. Enemies start with different amounts of hitpoints, depending on their species. Dead enemies become dirt, skeletons or "magic meat" -- such objects can be collected, and "magic meat" can be consumed -to gain hitpoints. Note that different kinds of movements/actions take different +to gain hitpoints (if allowed to lie on the ground for a while it may even +multiply ...). Note that different kinds of movements/actions take different numbers of turns to finish. Enemies' AI is very dumb so far: Each turn, they try to move towards their -shortest-path-wise nearest enemy visible to them. If they see no enemy, they -just wait. +shortest-path-wise nearest enemy (any animate being of a different species) +visible to them. If they see no enemy, they search for and consume "magic meat". Every move of yours re-writes a file "savefile" that describes the new state of -the world. Once you re-start the game, the game state is recreated from the -"savefile" file. To start over in a new world, simply delete this file. +dthe world, if more than 15 seconds have passed since its last writing. Once you +re-start the game, the game state is recreated from the "savefile" file. To +start over in a new world, simply delete this file. System requirements / installation / running the game ----------------------------------------------------- @@ -44,18 +46,20 @@ the two by hand. Client's keybindings and window management ------------------------------------------ -In the client's default window configuration, the window appearing on the left -sports a list of keybindings available globally, and additionally via the window -selected as active. - -Hit "W" (per default keybindings) to switch the "active" window to a view that -allows changing its geometry. One more hit on "W" switches the window to a view -that allows changing its window-specific keybindings. The global keybindings can -be changed in the "Global keys" window, those of the window geometry -configuration in the "Window geometry keys" window, and those of the -window-specific keybindings configuration in the "Window keybinding keys" -window; by default, these three windows are not visible, but may be turned on by -(per default keybindings) hitting the "F6", "F7" and "F8" keys. +Multiple windows may fill the screen. One of these will be selected as "active" +– identified by dollar signs enclosing its title. Active windows may come with +window-specific keybindings. Furthermore, global keybindings are available no +matter what window is selected. + +Hit "W" (per default global keybindings) to switch the active window to a view +that allows changing its geometry. One more hit on "W" switches the window to a +view that sports (and allows changing its) window-specific keybindings. (One +further "W" will return the window to its default, "normal" view.) The global +keybindings are visible (and can be changed) in the "Set global keys" window, +those of the window geometry configuration in the "Set window geometry keys" +window, and those of the window-specific keybindings configuration in the "Set +window keybinding keys" window; by default, the latter two are not visible, but +may be turned on by (per default keybindings) hitting the keys "F6" and "F7". Keybindings and default window selection / visibilities / geometries are read from the textfile ./confclient/interface_conf by default, or by another one @@ -84,10 +88,9 @@ Hacking / server internals and configuration -------------------------------------------- The game world is set up and made subject to player commands by -./roguelike-server. It's controlled by commands explained in the file … -The server usually reads these from the files ./server/in (written to by -./roguelike-client), ./confserver/world, ./record and ./savefile. See the file -./SERVER_COMMANDS for details. +./roguelike-server. It's controlled by commands explained in the file +./SERVER_COMMANDS. The server usually reads these from the files ./server/in +(written to by ./roguelike-client), ./confserver/world, ./record and ./savefile. All source files are thoroughly documented to explain more details of plomrogue's internals. The ./roguelike-server executable can be run with a -v