Frames per second.

An Event is a Tick (time passes) or a KeyPress.

Game definition datatype, parametrised on your gamestate. The two most important elements are the function dealing with logic and the drawing one. Check alone (you can compile it with cabal new-run -f examples alone) to see a simple game in action.

Entry point for the game execution, should be called in main.

You must compile your programs with -threaded; if you do not do this the game will crash at start-up. Just add:

ghc-options:      -threaded

in your .cabal file and you will be fine!

An Animation is a series of timed time-separated Planes.

Creates an Animation.

Alias for fetchFrame.

Alias for isExpired.

A two-dimensional surface (Row, Column) where to blit stuff.

Rows and Columns are 1-based (top-left position is 1 1).

Expressed in Columns.

Expressed in Rows.

Creates an empty, opaque Plane.

Creates Plane from String, good way to import ASCII art/diagrams.

Same as stringPlane, but with transparent Char.

Adds transparency to a plane, matching a given character

Changes every transparent cell in the Plane to an opaque ' ' character.

A String (n divided and ended) representing the Plane. Useful for debugging/testing purposes.

Dimensions or a plane.

A drawing function, usually executed with the help of %.

Pastes one Plane onto another. To be used along with & like this:

 d :: Plane
 d =          blankPlane 100 100  &
     (3, 4) % box '_' 3 5         &
     (a, b) % cell 'A' # bold

Apply style to plane, e.g.

cell 'w' # bold

& is a reverse application operator. This provides notational convenience. Its precedence is one higher than that of the forward application operator $, which allows & to be nested in $.

>>> 5 & (+1) & show
"6"

Since: base-4.8.0.0

Shorthand for sequencing Planes, e.g.

          firstPlane  &
 (3, 4) % secondPlane &
 (1, 9) % thirdPlane

is equal to

 mergePlanes firstPlane [((3,4), secondPlane),
                         ((1,9), thirdPlane)]

A 1x1 cell.

A box of dimensions w h.

A text-box. Assumes ' ' are transparent.

Set foreground color.

Apply bold style to Plane.

Swap foreground and background colours of Plane.

Tests a game in a pure environment. You can supply the Events yourself or use recordGame to obtain them.

Play as in playGame and write the session to file. Useful to produce input for testGame and replayGame. Session will be recorded even if an exception happens while playing.

Reads a file containing a recorded session.

Similar to testGame, runs the game given a list of Events. Unlike testGame, the playthrough will be displayed on screen. Useful when a test fails and you want to see how.

See this in action with cabal new-run -f examples alone-playback.

Wraps an IO computation so that any error gets displayed along with a <press any key to quit> prompt. Some terminals shut-down immediately upon program end: errorPress makes it easier to beta-test games on those terminals.