ansi-canvas

ansi-canvas

Render a <canvas> node to your terminal

This module provides a <canvas> object backed by node-canvas, with its width and height properties automatically set to the proper size of the terminal window.

The result is that you can use the HTML Canvas API to render directly to your terminal!

Installation

Install with npm:

$ npm install ansi-canvas

Example

var ac = require('ansi-canvas');

var canvas = ac();
var context = canvas.getContext('2d');

// draw a purple background
context.fillStyle = 'purple';
context.fillRect(0, 0, canvas.width, canvas.height);

// write some text
context.fillStyle    = '#00f';
context.font         = 'italic 15px sans-serif';
context.textBaseline = 'top';
context.fillText  ('Hello world!', 1, 1);
context.font         = 'bold 20px sans-serif';
context.strokeText('Hello world!', 1, 21);

// IMPORTANT!!!
// call `canvas.render()` when you're ready to flush the canvas to the terminal
canvas.render();

Outputs something like:

Set the Font Size Really Small!

And then you get really high resolution, and then you could do something crazy… like… render SNES directly in your Terminal!!!

(note: this is just an image. if you were to actually implement SNES in the Terminal at a reasonable framerate and resolution you'd be god-like, but please let me know if you do it!)

License

(The MIT License)

Copyright (c) 2013 Nathan Rajlich <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.