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 INSTALLATION.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);
});

❓ Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. 🐛
3. For direct and quick help from me, you can use Codementor. 🚀

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.

💖 Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like 🚀

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! ❤️

💫 Where is this library used?

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

• aceituna (by Dave Greene)—Drool worthy
• alphabet-cli—undefined
• ascii-github—GitHub CLI Client
• bing-cli (by Scott Beaudreau)—Use Bing Search in the terminal via command line
• bronos (by Keith Williams)—A sonos cli for bros
• cli-emoji—Big emojis in your terminal.
• cli-github—A fancy GitHub client for command line.
• doomjs (by Fabio Cencetti)—A bunch of modular gulp tasks
• gif-cli—Gif animations in your terminal!
• gongxi (by clonn)—恭喜系列 cli
• goteem (by Austin Kelleher, [email protected])—goteem
• 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源代码
• img-to-svg—Convert the image pixels in SVG squares.
• imgurize (by Michael Kaminsky)—an Imgur browser in the terminal
• joctodex—Octocats in terminal!
• js2image (by yutou)—用js代码和图片，生成一段可以正常运行的图形化的js源代码
• kayak-inside (by Stewart Ulm)—Team Directory
• mdy—View markdown files in the command line with ANSI styled images.
• nobro (by Mario Scheliga)—Prevent brothers and sisters from falling to the dark side by robbing their npm-workflow virginity
• node.cobol—Node.js bridge for COBOL which allows you to run Node.js code from COBOL.
• noslide-js (by fly)—A Simple Terminal slide tool
• nrk-tv-cli (by Hans Kristian Flaatten)—Command line client for interacting with TV programs from the Norwegian Broadcasting Corporation (NRK)
• path-cli (by Muhammad Mustadi)—
• protractor-screenshoter-plugin (by Andrej Zachar)—A jasmine2 protractor plugin that captures for each browser instance a screenshot and browsers' console logs. The snapshot is made optionally for each expect or spec. Plugins comes with a beautiful angular based analytics tool to visually check and fix te
• 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.

📜 License

MIT © Ionică Bizău