Permalink
Browse files

Update the docs to the LambdaHack library version

  • Loading branch information...
1 parent 559a6cb commit c1fe2762bfbd51f93c1a0cc75c2ff8052940607b @Mikolaj Mikolaj committed Nov 11, 2011
Showing with 62 additions and 48 deletions.
  1. +1 −2 CREDITS
  2. +24 −12 PLAYING.md
  3. +37 −34 README.md
View
3 CREDITS
@@ -1,6 +1,5 @@
-All kinds of contributions to Allure of the Stars are gratefully welcome!
+All kinds of contributions to the LambdaHack engine are gratefully welcome!
Some of the contributors are listed below, in chronological order.
Andres Loeh
Mikolaj Konarski
-Krzysztof Pławski
View
36 PLAYING.md
@@ -1,20 +1,18 @@
-Playing Allure of the Stars
-===========================
-
-Playing Allure of the Stars involves walking around the dungeon
-(err, a Solar System space-ship that incidentally closely resembles
-a fantasy dungeon, in this pre-release version of the game),
-alone or in a party of fearless adventurers, jumping between levels,
-bumping into monsters, doors and walls, gathering magical treasure
+Playing LambdaHack
+==================
+
+LambdaHack is a small dungeon crawler illustrating the roguelike game engine
+library also called LambdaHack. Playing the game 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.
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, a lot of imagination is required
-right now, but the game is already playable and winnable.
-Contributions welcome.
+for this simple game, but it's is playable and winnable.
Dungeon
@@ -27,11 +25,14 @@ The basic tiles are as follows.
dungeon terrain type on-screen symbol
floor .
- wall #
+ corridor #
+ wall (horizontal and vertical) - and |
+ pillar wall O
stairs up <
stairs down >
- open door '
+ open door | and -
closed door +
+ rock blank
The game world is persistent, i.e., every time the player visits a level
during a single game, the level layout is the same. Some items
@@ -144,3 +145,14 @@ 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.
+
+
+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 config.default to
+~/.LambdaHack/config and modify it, but be careful changing
+gameplay options --- this can easily unbalance or break the game.
View
71 README.md
@@ -1,70 +1,73 @@
-Allure of the Stars
-===================
-
-This is an alpha pre-release of Allure of the Stars,
-a near-future Sci-Fi [roguelike] [1] and tactical squad game.
-Long-term goals are high replayability and auto-balancing
-through procedural content generation and persistent content
-modification based on player behaviour.
-The game is written in [Haskell] [2] and based
-on the [LambdaHack roguelike engine] [3].
+LambdaHack
+==========
+
+This is an alpha release of LambdaHack, a [Haskell] [1] game engine
+library for [roguelike] [2] games of arbitrary theme, size and complexity.
+When completed, it will let you specify content to be procedurally generated,
+define the AI behaviour on top of the generic content-independent rules,
+override any of the generic engine components and compile a ready-to-play
+game binary, using either the supplied or a custom-made main loop.
+Long-term goals for LambdaHack include support for tactical squad combat,
+in-game content creation, auto-balancing and persistent content modification
+based on player behaviour.
+
+The engine comes with a sample code for a little dungeon crawler,
+called LambdaHack and described in PLAYING.md. The engine and the example
+game are bundled together in a single [Hackage] [3] package.
+You are welcome to create your own game by modifying the sample game
+and the engine code, but please consider eventually splitting your changes
+into a separate Hackage package that depends on the upstream library,
+to help us exchange ideas and share improvements to the common code.
+There is at least one more game using the LambdaHack library on Hackage,
+a near-future Sci-Fi game called [Allure of the Stars] [4].
Compilation and installation
----------------------------
-The game is best compiled and installed via Cabal, which also takes care
-of all dependencies. The latest official version of the game can be downloaded
-automatically by Cabal from [Hackage] [4] as follows
+The library is best compiled and installed via Cabal, which also takes care
+of all dependencies. The latest official version of the library
+can be downloaded automatically by Cabal from [Hackage] [3] as follows
- cabal install Allure
+ cabal install LambdaHack
For a more current snapshot, download the source from [github] [5]
and run Cabal from the main directory
cabal install
-The best frontend (keyboard support and colours) is gtk,
-but if needed, you may try one of the terminal frontends with, e.g,
+For the example game, the best frontend (keyboard support and colours)
+is gtk, but if needed, you may compile the game binary with one
+of the terminal frontends using Cabal flags, e.g,
cabal install -fvty
To use a crude bot for testing the game, you have to compile with
-the standard input/output frontend, as follows
+the standard intput/output frontend, as follows
cabal install -fstd
and run the bot, for example, in the following way
- BotAllure 42 20000000 | Allure > /tmp/log
+ BotLambdaHack 42 20000000 | LambdaHack > /tmp/log
You may wish to tweak the game configuration file to let the bot play longer,
e.g., by making the dungeon much deeper, as in the supplied config.bot.
-Savegame directory
-------------------
-
-If you don't want Allure of the Stars to write to the current directory,
-create a personal savegame directory (on Linux it's ~/.Allure/).
-and copy the scores file there. You may also want to
-copy the configuration file src/config.default to
-~/.Allure/config and modify it, but be careful changing
-gameplay options --- they can easily unbalance or break the game.
-
-
Further information
-------------------
-For more information, visit the wiki at https://github.com/Mikolaj/Allure/wiki
+For more information, visit the wiki (!!!!!!!!!!!!!TODO!!!!!!!!!!)
+at https://github.com/kosmikus/LambdaHack/wiki
and see the files PLAYING.md, CREDITS and LICENSE.
Have fun!
-[1]: http://roguebasin.roguelikedevelopment.org/index.php?title=Berlin_Interpretation
-[2]: http://www.haskell.org/
-[3]: http://github.com/kosmikus/LambdaHack
+[1]: http://www.haskell.org/
+[2]: http://roguebasin.roguelikedevelopment.org/index.php?title=Berlin_Interpretation
+[3]: http://hackage.haskell.org/package/LambdaHack
[4]: http://hackage.haskell.org/package/Allure
-[5]: http://github.com/Mikolaj/Allure
+[5]: http://github.com/kosmikus/LambdaHack

0 comments on commit c1fe276

Please sign in to comment.