Skip to content
Declarative terminal graphics for OCaml
Branch: master
Clone or download
pqwy düner kebab
yay
Latest commit 4331cbf Mar 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
benchmarks düner kebab Mar 10, 2019
doc revert to upstream Unicode Oct 11, 2017
examples düner kebab Mar 10, 2019
src-lwt düner kebab Mar 10, 2019
src-unix
src düner kebab Mar 10, 2019
.gitignore
.ocamlinit düner kebab Mar 10, 2019
.travis.yml
CHANGES.md
LICENSE.md spring cleaning Jul 5, 2017
README.md
dune-project düner kebab Mar 10, 2019
notty.opam düner kebab Mar 10, 2019

README.md

Notty — Declaring terminals

Notty is a declarative terminal library for OCaml structured around a notion of composable images. It tries to abstract away the basic terminal programming model, providing something simpler and more expressive.

The core layout engine and IO codecs are pure platform-independent OCaml. Distribution includes modules with input and output facilities for Unix, and Lwt on Unix.

As an attempt to redefine terminal programming, Notty has to be opinionated. It assumes Unicode throughout, does not have universal support for various terminals out there, and has a peculiar programming and rendering model.

Notty's core API was heavily influenced by Haskell's Vty.

Where to start

Check out the documentation, examples, or peek directly into the interface file.

Building with dune build @examples will produce several little example programs that also double as tests.

(* Game of Life with ZX Spectrum kitsch. *)

let dot : image = I.uchar A.(fg lightred) (Uchar.of_int 0x25cf) 1 1

let background step (n, m) =
  let k = 24. *. sin (float (step + m + n) /. 10.) |> truncate in
  if k > 0 then I.char A.(fg (gray k)) '.' 1 1 else I.void 1 1

let render (w, h) step life : image =
  I.tabulate w (h - 1) @@ fun x y ->
    let pt = (x, y) in
    if CSet.mem pt life then dot else background step pt

Why?

  • Notty?

    Terminals are tedious to program for. Notty tries to abstract the tedium away, leaving you with a more pleasant programming surface that's quite unlike a TTY. Hence, No-TTY.

  • Why make yet another terminal library?

    Because:

    • It allows one to describe what should be seen, as opposed to commanding a terminal.
    • It's pretty compact. Both bells and whistles can be implemented separately.
    • Core is easy to glue onto various IO backends.
    • Pure platform-independent OCaml.

Build Status

You can’t perform that action at this time.