yay/vendor/github.com/nsf/termbox-go
Stephen McQuay 9f47b066db
vendored deps
2016-05-04 09:02:23 -07:00
..
AUTHORS vendored deps 2016-05-04 09:02:23 -07:00
LICENSE vendored deps 2016-05-04 09:02:23 -07:00
README.md vendored deps 2016-05-04 09:02:23 -07:00
api.go vendored deps 2016-05-04 09:02:23 -07:00
api_common.go vendored deps 2016-05-04 09:02:23 -07:00
api_windows.go vendored deps 2016-05-04 09:02:23 -07:00
collect_terminfo.py vendored deps 2016-05-04 09:02:23 -07:00
syscalls.go vendored deps 2016-05-04 09:02:23 -07:00
syscalls_darwin.go vendored deps 2016-05-04 09:02:23 -07:00
syscalls_darwin_amd64.go vendored deps 2016-05-04 09:02:23 -07:00
syscalls_freebsd.go vendored deps 2016-05-04 09:02:23 -07:00
syscalls_linux.go vendored deps 2016-05-04 09:02:23 -07:00
syscalls_netbsd.go vendored deps 2016-05-04 09:02:23 -07:00
syscalls_openbsd.go vendored deps 2016-05-04 09:02:23 -07:00
syscalls_windows.go vendored deps 2016-05-04 09:02:23 -07:00
termbox.go vendored deps 2016-05-04 09:02:23 -07:00
termbox_common.go vendored deps 2016-05-04 09:02:23 -07:00
termbox_windows.go vendored deps 2016-05-04 09:02:23 -07:00
terminfo.go vendored deps 2016-05-04 09:02:23 -07:00
terminfo_builtin.go vendored deps 2016-05-04 09:02:23 -07:00

README.md

Termbox

Termbox is a library that provides a minimalistic API which allows the programmer to write text-based user interfaces. The library is crossplatform and has both terminal-based implementations on *nix operating systems and a winapi console based implementation for windows operating systems. The basic idea is an abstraction of the greatest common subset of features available on all major terminals and other terminal-like APIs in a minimalistic fashion. Small API means it is easy to implement, test, maintain and learn it, that's what makes the termbox a distinct library in its area.

Installation

Install and update this go package with go get -u github.com/nsf/termbox-go

Examples

For examples of what can be done take a look at demos in the _demos directory. You can try them with go run: go run _demos/keyboard.go

There are also some interesting projects using termbox-go:

  • godit is an emacsish lightweight text editor written using termbox.
  • gomatrix connects to The Matrix and displays its data streams in your terminal.
  • gotetris is an implementation of Tetris.
  • sokoban-go is an implementation of sokoban game.
  • hecate is a hex editor designed by Satan.
  • httopd is top for httpd logs.
  • mop is stock market tracker for hackers.
  • termui is a terminal dashboard.
  • termloop is a terminal game engine.
  • xterm-color-chart is a XTerm 256 color chart.
  • gocui is a minimalist Go library aimed at creating console user interfaces.
  • dry is an interactive cli to manage Docker containers.

API reference

godoc.org/github.com/nsf/termbox-go