image-to-ascii

A Node.JS module that converts images to ASCII art.

☁️ Installation

$ npm i --save image-to-ascii

💡 ProTip: You can install the cli version of this module by running npm i -g image-to-ascii-cli

Check out the INSTALLTION.md guide for more information.

📋 Example

// Dependencies
const imageToAscii = require("image-to-ascii");

// The path can be either a local path or an url
imageToAscii("https://octodex.github.com/images/octofez.png", (err, converted) => {
    console.log(err || converted);
});

// Passing options
imageToAscii("https://octodex.github.com/images/privateinvestocat.jpg", {
    colored: false
}, (err, converted) => {
    console.log(err || converted);
});

In order to run the webcam.sh provided in the example folder, you will also need streamer. The script uses streamer to make webcam pictures and converts them into ASCII art using the webcam.js

# Ubuntu
$ sudo apt-get install streamer

To run the script just use:

sh webcam.sh

📝 Documentation

`imageToAscii(source, options, callback)`

Converts the provided image in ASCII art.

Params

String source: The path/url to the image.
Object|String options: The path to the image or an object containing the following fields:

Size Options:

pxWidth (Number): The pixel width used for aspect ratio (default: 2).
size (Object): The size of the result image (ASCII art)—interpreted by compute-size:
- height (Number|String): The height value (default: "100%").
- width (Number|String): The width value (default: computed value to keep aspect ratio). This is optional if the height is provided.
size_options (Object): The options for compute-size:
- screen_size (Object): The screen size (defaults to terminal width and height):
  - width (Number): The screen width.
  - height (Number): The screen height.
- px_size (Object): The pixel size.
  - width (default: 1)
  - height (default: 1)
- preserve_aspect_ratio (Boolean): If false, the aspect ratio will not be preserved (default: true).
- fit_screen (Boolean): If false, the result size will not fit to screen (default: true).

Matrix asciifier options:

stringify (Boolean): If false, the pixel objects will not be stringified.
concat (Boolean): If false, the pixel objects will not be joined together.

Pixel asciifier options:

pixels (Array|String): An array or string containing the characters used for converting the pixels in strings (default: " .,:;i1tfLCG08@").
reverse (Boolean): If true, the pixels will be reversed creating a negative image effect (default: false).
colored (Boolean): If true, the output will contain ANSI styles (default: true).
bg (Boolean): If true, the background color will be used for coloring (default: false).
fg (Boolean): If true, the foreground color will be used for coloring (default: true).
white_bg (Boolean): Turn on the white background for transparent pixels (default: true).
px_background (Object): An object containing the r (red), g (green) and b (blue) values of the custom background color.

Other options:

image_type (String): Use this to explicitely provide the image type.
stringify_fn (Function): A function getting the pixels matrix and the options in the arguments. Use this option to implement your own stringifier.
Function callback: The callback function.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

alphabet-cli—undefined
ascii-github—GitHub CLI Client
cli-github—A fancy GitHub client for command line.
cli-sunset—A fancy command line tool for knowing the sunset time.
doomjs (by Fabio Cencetti)—A bunch of modular gulp tasks
gif-cli—Gif animations in your terminal!
ick (by Kyle Kelley)—Interactive Console Experiment
image-to-ascii-cli—View images in text format, in your terminal.
image-to-js (by yutou)—用js代码和图片，生成一段可以正常运行的图形化的js源代码
imgurize (by Michael Kaminsky)—an Imgur browser in the terminal
joctodex—Octocats in terminal!
js2image (by yutou)—用js代码和图片，生成一段可以正常运行的图形化的js源代码
nrk-tv-cli (by Hans Kristian Flaatten)—Command line client for interacting with TV programs from the Norwegian Broadcasting Corporation (NRK)
salestock-cli (by Muhammad Mustadi)—salestock CLI app
terminal-sidecar (by Kyle Kelley)—Jupyter sidecar in your terminal
tmuxos—The awesome power of command line is finally revealed.

aleen42/image-to-ascii