ascii-images

ascii-images by @michalbe

Convert .png images to ASCII characters

What?

This library displays .png images in the command line. Example:

• Image:
  

• And generated ASCII image:
  

API

This library takes two parameters:

AsciiImages('path/to/the/image.png', callback);

The only parameter passed to the callback is our image converted to ascii, all we want to do now is display it in commandline, for instance using console.log.

How to use?

Install simply with: bash npm install ascii-images

Then in your code:
```javascript
var ai = require('ascii-images');

ai('test-image.png', function(result){
  console.log(result);
});

How it works?

When the image is passed to the library, it uses PNG-JS to decode pixel values from it (like getImageData() on HTML5 canvas), and width of the image using image-size package. Then it iterates through the array of pixels and change them to 8-bit Xterm color numbers using color2xterm library. Then everything is coloured using cli-color library.

Limitations

• PNG-JS works only with .png files
• xTerm colors are 'Not supported on Windows and some terminals. However if used in not supported environment, the closest color from basic (16 colors) palette is chosen' - quote form cli-color lib.