https://github.com/klardotsh/node-termbox

Node.JS bindings to termbox
https://github.com/klardotsh/node-termbox

Last synced: 26 days ago
JSON representation

Node.JS bindings to termbox

• Host: GitHub
• URL: https://github.com/klardotsh/node-termbox
• Owner: klardotsh
• License: other
• Created: 2013-07-26T20:00:12.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-10-04T18:45:18.000Z (about 10 years ago)
• Last Synced: 2023-08-02T13:23:00.932Z (over 1 year ago)
• Language: C++
• Size: 148 KB
• Stars: 2
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
node-termbox

============

> ## WARNING 04 Oct 2014: UNMAINTAINED

> There's a greater-than-zero chance these bindings are entirely useless against modern versions of Termbox, as I've had no projects using this providing motivation to update the bindings. PRs welcome, otherwise this repository is mostly kept around for historical purposes.

>

> -- Josh

Some simple bindings of [termbox](http://github.com/nsf/termbox) to

node.js. Not perfect at all, and I'm sure there's bugs somewhere, but

for a one-nighter it worked out pretty well. I seem to be able to do

anything I would need to (time will tell). Bug reports welcome.

FUNCTIONS

---------

    init() -> [Number]

    shutdown() -> [Number] -- Always 0

    width() -> [Number]

    height() -> [Number]

    clear() -> [Number] -- Always 0

    present() -> [Number] -- Always 0

    setCursor(x, y) [Number], [Number] -> [Number] -- Always 0

    hideCursor() -> [Number] -- Always 0

    changeCell(x, y, char, fg, bg) [Number], [Number], [String], [Number], [Number] -> [Number] -- Always 0

    selectInputMode(mode) [Number] -> [Number]

    setClearAttributes(fg, bg) [Number], [Number]

    peekEvent(timeout) [Number] (milliseconds) -> [Object] -- type, mod, key, ch, w, h

    pollEvent() -> [Object] -- type, mod, key, ch, w, h

CONSTANTS

---------

I'll spare you the detail of *every single one* of these, as it's a

massive list. I expose everything defined in termbox.h, so go to town.

LICENSE

-------

    Copyright (c) 2013 Josh Klar 

    

    Do whatever you want with this code as long as you leave this header.

    This code has no warranty. If shit hits the fan, it's your problem.