The big, ugly, pending pull request

.gitignore

@@ -1,4 +1,4 @@
-LambdaHack.save
+save
 dist/
 *~
 *.swp

CREDITS

@@ -1,4 +1,5 @@
-Developers who have contributed significantly to LambdaHack:
+All kinds of contributions to LambdaHack are gratefully welcome!
+Some of the contributors are listed below, in chronological order.
 
 Andres Loeh
 Mikolaj Konarski

LambdaHack.cabal

@@ -3,8 +3,9 @@ name:          LambdaHack
 version:       0.1.20110117
 license:       BSD3
 license-file:  LICENSE
+tested-with:   GHC==7.0.3
 data-files:    LICENSE, CREDITS, DESIGN.markdown, PLAYING.markdown,
-               README.markdown, LambdaHack.config.example
+               README.markdown, src/config.default, scores
 author:        Andres Loeh <mail@andres-loeh.de>
 maintainer:    Andres Loeh <mail@andres-loeh.de>
 description:   a small roguelike game
@@ -22,22 +23,27 @@ flag vty
   default:       False
 
 executable LambdaHack
-  main-is:       LambdaHack.hs
+  main-is:       Main.hs
   hs-source-dirs:src
-  other-modules: Actor, Action, Actions, Command, Display, Display2, Dungeon,
-                 File, FOV, FOV.Common, FOV.Digital, FOV.Permissive, FOV.Shadow,
-                 Frequency, Geometry, Item, ItemState,
-                 Keys, Keybindings, LambdaHack, Level, LevelState, Message,
-                 Monster, Perception, Random, Save, State, Strategy,
-                 StrategyState, Turn, Version, HighScores, Config,
-                 Grammar
-  build-depends: base >= 4 && <5, containers >= 0.1 && < 1,
+  other-modules: Action, Actions, Color, Command, Config, ConfigDefault,
+                 Display, Dungeon, DungeonState, Effect, EffectAction, File,
+                 FOV, FOV.Common, FOV.Digital, FOV.Permissive, FOV.Shadow,
+                 Frequency, Geometry, GeometryRnd, Grammar,
+                 HighScores, Item, ItemKind, ItemAction,
+                 Keys, Keybindings, Level, LevelState,
+                 Main, Message, MovableAdd, MovableKind, Movable, MovableState,
+                 Multiline, Perception, Random,
+                 Save, State, Strategy, StrategyState,
+                 Turn, Terrain, Version
+  build-depends: base >= 4 && < 5, containers >= 0.1 && < 1,
                  binary >= 0.4 && < 1,
                  random >= 1 && < 2, zlib >= 0.4 && < 1,
                  bytestring >= 0.9 && < 1, directory >= 1 && < 2,
                  mtl >= 1.1 && < 3, old-time, ConfigFile >= 1.0.6 && < 2,
-                 MissingH >= 1.1.0.3 && < 1.2, filepath >= 1.1.0.3 && < 1.2
-  extensions:    CPP, FlexibleContexts
+                 MissingH >= 1.1.0.3 && < 1.2, filepath >= 1.1.0.3 && < 2,
+                 template-haskell >= 2.5
+  extensions:    CPP, FlexibleContexts, QuasiQuotes, MultiParamTypeClasses,
+                 RankNTypes, BangPatterns
   if flag(curses) {
     other-modules: Display.Curses
     build-depends: hscurses >= 1.3 && < 2

PLAYING.markdown

@@ -1,58 +1,71 @@
 Playing LambdaHack
 ==================
 
-Playing the game consist of walking around the dungeon and bumping
-into things (doors, monsters, treasure). Once the few basic command keys
-and on-screen symbols are learned, mastery and enjoyment of the game
-is the matter of tactical skill and literary imagination.
+Playing LambdaHack involves walking around the dungeon,
+alone or in a party of fearless adventurers, jumping between levels,
+bumping into monsters, doors and walls, gathering magical treasure
+and making creative use of it. The bloodthirsty monsters do the same,
+intelligence allowing, while tirelessly chasing the noble heroes
+by smell and night-sight.
 
-To be honest, right now you need a lot of imagination, since the game
-is very basic, though playable and winnable. Contributions welcome.
+Once the few basic command keys and on-screen symbols are learned,
+mastery and enjoyment of the game is the matter of tactical skill
+and literary imagination. To be honest, you need a lot of imagination
+right now, since the game is still quite basic, though playable and winnable.
+Contributions welcome.
 
 
 Dungeon
 -------
 
-The goal of the hero is to explore the dungeon from top to the very bottom
-(and grab lots of shiny treasure and gear on the way).
+The goal of the hero is to explore the dungeon, battle the horrors within,
+gather as much gold and gems as possible, and escape to tell the tale.
 The dungeon consists of 10 levels and each level consists of 80 by 21 tiles.
-The basic tiles tiles are as follows:
+The basic tiles are as follows.
 
                dungeon terrain type               on-screen symbol
                floor                              .
                wall (horizontal and vertical)     - and |
+               pillar wall                        O
                corridor                           #
                stairs (up and down)               < and >
                closed door                        +
+               open door                          | and -
                rock                               blank
 
-The game world is persistent, i.e., every time the hero visits a level
-during one game, the level should look the same.
+The game world is persistent, i. e., every time a hero visits a level
+during a single game, the level layout looks the same. Some items
+aid in dungeon exploration, e.g., a ring of searching improves the speed
+of finding hidden doors by heroes and monsters. The higher the magical
+bonus displayed for this and other dungeon items, the more effective it is.
+Only the best item carried in a hero's or monster's inventory counts.
+You can throw the rest away, but beware that your adversaries may pick it up
+and use it against you.
 
 
 Keys
 ----
 
-Here are a few keys you can use in the game:
+Below are the basic default keys.
 
                key    command
+               .      wait
+               <      ascend a level
+               >      descend a level
+               ?      display help
+               Q      quit without saving
+               X      save and exit the game
                c      close a door
                d      drop an object
+               g      get an object
                i      display inventory
-               o      open a door
-               s      search for secret doors
+               o      open a door (alternatively, you can bump into a door)
                q      quaff a potion
-               M      display previous messages
-               S      save and quit the game
-               Q      quit without saving
-               .      wait
-               ,      pick up an object
-               :      look around
-               <      ascend a level
-               >      descend a level
+               r      read a scroll
+               s      search for secret doors (or you can bump into a wall)
 
 One of the ways of moving throughout the level is with the vi text editor keys
-(also known as "Rogue-like keys"):
+(also known as "Rogue-like keys").
 
                key    command
                k      up
@@ -67,45 +80,74 @@ One of the ways of moving throughout the level is with the vi text editor keys
 Pressing a capital letter corresponding to a direction key will have
 the hero run in that direction until something interesting occurs.
 
-It's also possible to move using the numerical keypad, with Shift for running
-and the middle '5' key for resting. (If you are using the curses frontend,
+It is also possible to move using the numerical keypad, with Shift for running
+and the middle '5' key for waiting. (If you are using the curses frontend,
 numerical keypad may not work correctly for terminals with broken terminfo,
-e.g., gnome terminal tends to have problems, while xterm works fine.)
+e.g., gnome terminal has problems, while xterm works fine.)
 
-Below are also some debug and cheat keys. Use at your peril!
+To make a distance attack, you need to set your target first.
+The targeting commands are listed below, together with all the other
+less common player commands.
+
+               key    command
+               ESC    cancel action
+               RET    accept choice
+               TAB    cycle among heroes on level
+               0--9   select a hero anywhere in the dungeon (gtk only)
+               *      target monster
+               /      target location
+               D      dump current configuration
+               P      display previous messages
+               V      display game version
+               a      aim a wand
+               t      throw a weapon
+
+There are also some debug and cheat keys. Use at your peril!
 
                key    command
-               v      display the version of the game
                O      toggle "omniscience"
-               I      display level meta-data
-               R      toggle smell display
-               T      toggle level generation sequence
-               V      toggle field of vision display
+               I      inform about level meta-data
+               R      rotate display modes
+               T      cycle among level terrain generation stages
 
 
 Monsters
 --------
 
-The hero is not alone in the dungeon. Monsters roam the game world, too.
-Monsters inhabit specific locations on the game map, and can be seen
-if the tile they are on can be seen by the hero.
-Every monster gets a turn per move of the hero. Monster moves
-are restricted in the same way as hero moves, i.e., they cannot move
-into obstacles like walls or rock. Some monsters
-ignore the hero, others chase him only when they see him
-and the especially dangerous kind is able to smell the hero.
-
-When the hero moves into a monster or a monster bumps into the hero,
-combat occurs. Whenever combat occurs, the attacked party may lose some health.
-If the hero dies, the game ends.
+The hero is not alone in the dungeon. Monsters roam the dark caves
+and crawl from damp holes day and night. While heroes pay attention
+to all other party members and take moves sequentially, one after another,
+monsters don't care about each other and all move at once,
+sometimes brutally colliding by mistake.
+
+When the hero bumps into a monster or a monster attacks the hero,
+melee combat occurs. The best weapon carried by each opponent
+is taken into account for calculating bonus damage. The total damage
+the current hero can potentially inflict is displayed at the bottom
+of the screen. The total damage potential of a monster may change
+as it finds and picks up new weapons. Heroes and monsters running
+into another (with the Shift key) do not inflict damage, but change places.
+This gives the opponent a free blow, but can improve the tactical situation
+or aid escape.
+
+Throwing weapons at targets wounds them, consuming the weapon in the process.
+You can target a monster with the '*' key from the top row or numpad.
+You may throw any object in your possession
+(press '*' for a non-standard choice) or on the floor (press '-'),
+though only objects of a few kinds inflict any damage.
+Whenever a monster or a hero hit points reach zero, the combatant dies.
+When the last hero dies, the game ends.
 
 
 On Winning and Dying
 --------------------
 
-If you happen to die, you are free to start again from the first level
-of the dungeon, but all your treasure is gone and the dungeon will look
-different this time.
+You win the game if you escape the dungeon alive. Your score is
+the sum of all gold you've plundered plus 100gp for each gem.
+Only the loot in possession of the party members on level 1 counts
+(the rest is considered MIA).
 
-You win the game if you escape the dungeon alive with treasure and valuable
-items --- the more the better!
+If all heroes die, your score is halved and only the treasure carried
+by the last standing hero counts. You are free to start again
+from the first level of the dungeon, but all your wealth and items
+are gone and the dungeon and it's treasure look differently.

README.markdown

@@ -2,6 +2,10 @@ LambdaHack
 ==========
 
 LambdaHack is a small [roguelike] [1] game written in [Haskell] [2].
+It is getting more and more configurable and aims to become a flexible
+rouguelike engine, suitable for large and small dungeon crawling games
+of arbitrary themes. In particular, we try to keep AI independent
+of monster, item and terrain definitions.
 
 
 Compilation and installation
@@ -23,6 +27,17 @@ or you may try one of the terminal frontends with
     cabal install -fvty
 
 
+Savegame directory
+------------------
+
+If you don't want LambdaHack to write to the current directory,
+create a personal savegame directory (on Linux it's ~/.LambdaHack/).
+and copy the scores file there. You may also want to
+copy the configuration file src/config.default to
+~/.LambdaHack/config and modify it, but be careful changing
+gameplay options --- they can easily unbalance or break the game.
+
+
 Further information
 -------------------