https://github.com/fenwick67/term-px

Write pixels to the terminal in vertical pairs
https://github.com/fenwick67/term-px

Last synced: about 2 months ago
JSON representation

Write pixels to the terminal in vertical pairs

• Host: GitHub
• URL: https://github.com/fenwick67/term-px
• Owner: fenwick67
• Created: 2016-07-03T02:27:43.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-12-19T17:27:24.000Z (over 6 years ago)
• Last Synced: 2025-03-30T22:11:18.251Z (3 months ago)
• Language: JavaScript
• Homepage: http://fenwick67.github.io/term-px
• Size: 106 KB
• Stars: 24
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# term-px

Write pixels to the terminal using ANSI colors and half-characters.  [Try it here](http://fenwick67.github.io/term-px).

Verified to work in Windows CMD, Git Bash, xterm, and more.

![Demo](http://i.imgur.com/iwlN1Ru.gif)

You can see it yourself by running `img-test.js`.

## WHAT?

I'm kinda cheating.  Using special characters (namely ▀ █ and ▄) we're able to write an approximation of actual pixels to the terminal.

## Examples:

```javascript

var termPx = require('term-px');

/*

default usage

*/

var pixels = termPx([0,0,0],[255,255,255])

  //  => '\u001b[97;40m▄\u001b[0m'

  //  => 

// provide an options object with "format" set to "rgb" for use in full color terminals

var rgbPixels = termPx([0x9A,0x00,0xC4],[0xBB,0x00,0xC4],{format:"rgb"});

  //  => "\u001b[38;2;154;0;196;48;2;187;0;196m▀\u001b[0m"

  //  

// set "reset" to false to not reset the color at the end.

var unClosedRgbPixels = termPx([0x9A,0x00,0xC4],[0xBB,0x00,0xC4],{format:"rgb",reset:false});

  //  => "\u001b[38;2;154;0;196;48;2;187;0;196m▀"

/*

Preparing images:

*/

// Image data must be in RGBA 0-255 format, and have data and width keys.

var bmp = require("bmp-js");

var bmpBuffer = fs.readFileSync('aa.bmp');

var bmpData = bmp.decode(bmpBuffer); // {data:[255,0,255,255,...],width:10,height:20}

var logo = termPx.convertImage(bmpData,{format:"rgb"});

  // => (a massive String)

process.stdout.write(logo)

  // logo is shown

```