• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

_demos/H05-Dec-2016-

AUTHORSH A D05-Dec-2016101

LICENSEH A D05-Dec-20161 KiB

README.mdH A D05-Dec-20162.5 KiB

api.goH A D05-Dec-201611.7 KiB

api_common.goH A D05-Dec-20164.3 KiB

api_windows.goH A D05-Dec-20165.9 KiB

collect_terminfo.pyH A D05-Dec-20162 KiB

syscalls.goH A D05-Dec-2016773

syscalls_darwin.goH A D05-Dec-2016753

syscalls_darwin_amd64.goH A D05-Dec-2016775

syscalls_dragonfly.goH A D05-Dec-2016735

syscalls_freebsd.goH A D05-Dec-2016735

syscalls_linux.goH A D05-Dec-2016828

syscalls_netbsd.goH A D05-Dec-2016733

syscalls_openbsd.goH A D05-Dec-2016733

syscalls_windows.goH A D05-Dec-20161.5 KiB

termbox.goH A D05-Dec-201610.8 KiB

termbox_common.goH A D05-Dec-2016994

termbox_windows.goH A D05-Dec-201619.9 KiB

terminfo.goH A D05-Dec-20165.3 KiB

terminfo_builtin.goH A D05-Dec-20163.3 KiB

README.md

1## Termbox
2Termbox 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.
3
4### Installation
5Install and update this go package with `go get -u github.com/nsf/termbox-go`
6
7### Examples
8For 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`
9
10There are also some interesting projects using termbox-go:
11 - [godit](https://github.com/nsf/godit) is an emacsish lightweight text editor written using termbox.
12 - [gomatrix](https://github.com/GeertJohan/gomatrix) connects to The Matrix and displays its data streams in your terminal.
13 - [gotetris](https://github.com/jjinux/gotetris) is an implementation of Tetris.
14 - [sokoban-go](https://github.com/rn2dy/sokoban-go) is an implementation of sokoban game.
15 - [hecate](https://github.com/evanmiller/hecate) is a hex editor designed by Satan.
16 - [httopd](https://github.com/verdverm/httopd) is top for httpd logs.
17 - [mop](https://github.com/michaeldv/mop) is stock market tracker for hackers.
18 - [termui](https://github.com/gizak/termui) is a terminal dashboard.
19 - [termloop](https://github.com/JoelOtter/termloop) is a terminal game engine.
20 - [xterm-color-chart](https://github.com/kutuluk/xterm-color-chart) is a XTerm 256 color chart.
21 - [gocui](https://github.com/jroimartin/gocui) is a minimalist Go library aimed at creating console user interfaces.
22 - [dry](https://github.com/moncho/dry) is an interactive cli to manage Docker containers.
23 - [pxl](https://github.com/ichinaski/pxl) displays images in the terminal.
24 - [snake-game](https://github.com/DyegoCosta/snake-game) is an implementation of the Snake game.
25 - [gone](https://github.com/guillaumebreton/gone) is a CLI pomodoro® timer.
26 - [Spoof.go](https://github.com/sabey/spoofgo) controllable movement spoofing from the cli
27 - [lf](https://github.com/gokcehan/lf) is a terminal file manager
28
29### API reference
30[godoc.org/github.com/nsf/termbox-go](http://godoc.org/github.com/nsf/termbox-go)
31