https://github.com/ppkfs/bearlibterminal-hs

Low level Haskell bindings to the BearLibTerminal graphics library.
https://github.com/ppkfs/bearlibterminal-hs

Last synced: 10 months ago
JSON representation

Low level Haskell bindings to the BearLibTerminal graphics library.

• Host: GitHub
• URL: https://github.com/ppkfs/bearlibterminal-hs
• Owner: PPKFS
• License: other
• Created: 2024-06-09T09:55:21.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-07-22T16:43:10.000Z (11 months ago)
• Last Synced: 2025-08-23T01:37:37.816Z (10 months ago)
• Language: Haskell
• Size: 486 KB
• Stars: 21
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Hackage Version](https://img.shields.io/hackage/v/bearlibterminal)

# bearlibterminal-hs -

Also available on [Hackage](https://hackage.haskell.org/package/bearlibterminal).

Low-level Haskell bindings to the [BearLibTerminal](http://foo.wyrd.name/en:bearlibterminal) graphics library, primarily for roguelike games.

## Description

The design overview of the original library is excellent to get an understanding of how things work: http://foo.wyrd.name/en:bearlibterminal:design.

## Getting Started

### Installing

* This library assumes you have built the main `BearLibTerminal` library (or downloaded the precompiled binaries available from http://foo.wyrd.name/en:bearlibterminal) and your build tool can find it (e.g. by setting `LD_LIBRARY_PATH` or `DYLD_LIBRARY_PATH`).

* Add `bearlibterminal` to your `*.cabal` `build-depends`.

* Enjoy.

## How can I do things?

This is pretty much a 1-to-1 mapping of the original BLT API, with some marshalling of types and wrappers around function calls that take C strings (these are offered in `CString`, `Text`, and `String` flavours).

Every API call is available as both a raw FFI call (`c_terminal_snake_case`) and as a monadic `MonadIO m => ... m a` function.

Other notes:

- Colours are still simply 4-byte `Int`s. Higher level colour functions are available in `roguefunctor`.

- `terminalComposition` takes a `TerminalCompositionMode` rather than raw integers.

- Events read by `terminal_peek`, `terminal_read` are returned as raw integers (`terminalPeekCode`) and as `Keycode`s (`terminalPeek`).

## This is a bit too low level for me...

Check out the Haskell roguelike toolkit library [roguefunctor](https://github.com/ppkfs/roguefunctor), which is the high-level, opinionated wrapper around this library with nicer abstractions for positions, colours, config options, event handling, rendering, and so forth.

# Screenshots from the Omni demo

![screenshot](./Media/tilesets.png)

![screenshot](./Media/fontsize.png)