The LambdaHack package

[ Tags: bsd3, game, game-engine, library, program ] [ Propose Tags ]

This is an alpha release of LambdaHack, a game engine library for roguelike games of arbitrary theme, size and complexity, packaged together with a small example dungeon crawler.

When completed, the engine will let you specify content to be procedurally generated, define the AI behaviour on top of the generic content-independent rules and compile a ready-to-play game binary, using either the supplied or a custom-made main loop. Several frontends are available (GTK is the default) and many other generic engine components are easily overridden, but the fundamental source of flexibility lies in the strict and type-safe separation of code and content and of clients (human and AI-controlled) and server. Please see the changelog file for recent improvements and the issue tracker for short-term plans. Long term vision revolves around procedural content generation and includes in-game content creation, auto-balancing and persistent content modification based on player behaviour.

A larger game that depends on the LambdaHack library is Allure of the Stars, available from http://hackage.haskell.org/package/Allure.

Note: All modules in this library are kept visible, to let games override and reuse them. OTOH, to reflect that some modules are implementation details relative to others, the source code adheres to the following convention. If a module has the same name as a directory, the module is the exclusive interface to the directory. No references to the modules in the directory are allowed except from the interface module. This policy is only binding inside the library --- users are free to do whatever they please, since the library authors are in no position to guess their particular needs.


[Skip to Readme]

Properties

Versions 0.1.20080412, 0.1.20080413, 0.1.20090606, 0.1.20110117, 0.1.20110918, 0.2.0, 0.2.1, 0.2.6, 0.2.6.5, 0.2.8, 0.2.10, 0.2.10.5, 0.2.10.6, 0.2.12, 0.2.14, 0.4.9.0, 0.4.99.0, 0.4.100.0, 0.4.101.0, 0.4.101.1, 0.5.0.0, 0.6.0.0, 0.6.1.0, 0.6.2.0, 0.7.0.0
Change log CHANGELOG.md
Dependencies array (>=0.3.0.3 && <1), assert-failure (>=0.1 && <1), async (==2.*), base (==4.*), binary (>=0.7 && <1), bytestring (>=0.9.2 && <1), containers (>=0.5 && <1), deepseq (>=1.3 && <2), directory (>=1.1.0.1 && <2), enummapset-th (>=0.6.0.0 && <1), filepath (>=1.2.0.1 && <2), ghc-prim (>=0.2), gtk (>=0.12.1 && <0.13), hashable (>=1.1.2.5 && <2), hscurses (>=1.4.1 && <2), hsini (>=0.2 && <2), keys (==3.*), LambdaHack, miniutter (>=0.4.1 && <2), mtl (>=2.0.1 && <3), old-time (>=1.0.0.7 && <2), pretty-show (>=1.6 && <2), random (>=1.0.1 && <2), stm (>=2.4 && <3), template-haskell (>=2.6 && <3), text (>=0.11.2.3 && <2), transformers (>=0.3 && <1), unordered-containers (>=0.2.3 && <1), vector (>=0.10 && <1), vector-binary-instances (>=0.2 && <1), vty (>=4.7.0.6 && <5), zlib (>=0.5.3.1 && <1) [details]
License BSD3
Author Andres Loeh, Mikolaj Konarski
Maintainer Mikolaj Konarski <mikolaj.konarski@funktory.com>
Category Game Engine, Game
Home page http://github.com/LambdaHack/LambdaHack
Bug tracker http://github.com/LambdaHack/LambdaHack/issues
Source repository head: git clone git://github.com/LambdaHack/LambdaHack.git
Uploaded Fri Jul 25 15:08:44 UTC 2014 by MikolajKonarski
Updated Sat Jul 26 09:01:08 UTC 2014 by MikolajKonarski to revision 1   [What is this?]
Distributions NixOS:0.7.0.0
Executables LambdaHack
Downloads 7036 total (536 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI

Modules

[Index]

Flags

NameDescriptionDefaultType
vty

switch to the vty frontend

DisabledAutomatic
curses

switch to the curses frontend (not fully supported)

DisabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for LambdaHack-0.2.14

[back to package description]

LambdaHack Build StatusBuild Status

This is an alpha release of LambdaHack, a Haskell game engine library for roguelike games of arbitrary theme, size and complexity, packaged together with a small example dungeon crawler. When completed, the engine will let you specify content to be procedurally generated, define the AI behaviour on top of the generic content-independent rules and compile a ready-to-play game binary, using either the supplied or a custom-made main loop. Several frontends are available (GTK is the default) and many other generic engine components are easily overridden, but the fundamental source of flexibility lies in the strict and type-safe separation of code and content and of clients (human and AI-controlled) and server. Long-term goals for LambdaHack include support for multiplayer 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 package. You are welcome to create your own games 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.

Games known to use the LambdaHack library:

Compilation and installation

The library is best compiled and installed via Cabal (already a part of your OS distribution, or available within The Haskell Platform), which also takes care of all the dependencies. The latest official version of the library can be downloaded automatically by Cabal from Hackage as follows

cabal install LambdaHack

For a newer snapshot, download source from a development branch at github and run Cabal from the main directory

cabal install

For the example game, the best frontend (wrt keyboard support and colours) is the default gtk. To compile with one of the terminal frontends, use Cabal flags, e.g,

cabal install -fvty

Compatibility notes

The current code was tested with GHC 7.6 and 7.8, but should also work with other GHC versions.

If you are using the terminal frontends, numerical keypad may not work correctly depending on versions of the libraries, terminfo and terminal emulators. The curses frontend is not fully supported due to the limitations of the curses library. With the vty frontend run in an xterm, CTRL-keypad keys for running seem to work OK, but on rxvt they do not. Laptop (uk8o79jl) and Vi keys (hjklyubn, if enabled in config.ui.ini) should work everywhere regardless. GTK works fine, too.

Testing and debugging

The Makefile contains many sample test commands. All commands that use the screensaver game modes (AI vs. AI) and the dumb stdout frontend are gathered in make test. Of these, travis runs test-travis-* on each push to the repo. Test commands with prefix frontend start AI vs. AI games with the standard, user-friendly frontend.

Run LambdaHack --help to see a brief description of all debug options. Of these, --sniffIn and --sniffOut are very useful (though verbose and initially cryptic), for monitoring the traffic between clients and the server. Some options in the config file may prove useful too, though they mostly overlap with commandline options (and will be totally merged at some point).

You can use HPC with the game as follows (a quick manual playing session after the automated tests would be in order, as well, since the tests don't touch the topmost UI layer).

cabal clean
cabal install --enable-library-coverage
make test
hpc report --hpcdir=dist/hpc/mix/LambdaHack-0.2.14/ LambdaHack
hpc markup --hpcdir=dist/hpc/mix/LambdaHack-0.2.14/ LambdaHack

Note that debug option --stopAfter is required to cleanly terminate any automated test that is used to gather HPC info, because HPC needs a clean exit (to save data files).

Further information

For more information, visit the wiki and see PLAYING.md, CREDITS and LICENSE.

Have fun!