Drawing in terminal with unicode braille characters
JavaScript
Latest commit f676bea Nov 3, 2016 @madbence committed on GitHub Merge pull request #13 from madbence/docs/pretty
Clean up readme
Permalink
Failed to load latest commit information.
examples Update cube-thing Jun 12, 2014
.gitignore Fixes example requires May 21, 2014
.npmignore Add missing files Jun 11, 2014
.travis.yml chore: add travis Nov 1, 2015
LICENSE Initial commit May 5, 2014
README.md docs: clean up readme Oct 31, 2016
cube.gif Update cube-thing Jun 12, 2014
index.js Make width and height dynamic properties Oct 31, 2015
package.json 1.1.0 Nov 1, 2015

README.md

node-drawille Build Status

drawing in terminal with unicode braille characters. The idea is based on drawille by @asciimoo.

cube

install

install the package with npm:

$ npm install --save drawille

usage

See examples.

this module provides a very basic API only, for fancy things, like drawing lines, use another module, like bresenham.

drawille-canvas provides HTML5 Canvas API for drawille.

api

Canvas(w, h)

Create a new canvas with the given dimensions. w must be multiple of 2, h must be multiple of 4.

canvas.set(x, y)

Draw point on canvas at the given position.

canvas.unset(x, y)

Delete point on canvas at the given position.

canvas.toggle(x, y)

Toggle point on canvas at the given position.

canvas.clear()

Clear the whole canvas (delete every point).

canvas.frame([delimiter])

return the current content of canvas, as a delimiter-delimited string. delimiter defaults to \n.

it uses braille characters to represent points, so every line has length of w/2, and the string contains h/4 lines.

projects

  • vtop uses it to draw CPU and memory usage charts in the terminal
  • datop uses it to draw dat statistics
  • boscillate uses it to draw baudio soundwaves in real-time

license

MIT