Giter Club home page Giter Club logo

ascii-images's Introduction

ascii-images by @michalbe

Convert .png images to ASCII characters

What?

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

  • Image:
    image

  • And generated ASCII image:
    screen

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.

ascii-images's People

Contributors

michalbe avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.