1.0.14 • Published 4 years ago

asciify-pixel-matrix v1.0.14

Weekly downloads
3,245
License
MIT
Repository
github
Last release
4 years ago

asciify-pixel-matrix

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Asciifies a matrix of pixels.

:cloud: Installation

# Using npm
npm install --save asciify-pixel-matrix

# Using yarn
yarn add asciify-pixel-matrix

:clipboard: Example

const asciify = require("asciify-pixel-matrix");

console.log(asciify([{
    r: 255
  , g: 255
  , b: 255
}]));
// @

console.log(asciify([
    [{ r: 231, g: 76, b: 60, a: 0.4 }, { r: 241, g: 196, b: 15, a: 0.4 }, { r: 52, g: 152, b: 219, a: 0.4 }]
  , [{ r: 231, g: 76, b: 60, a: 0.6 }, { r: 241, g: 196, b: 15, a: 0.6 }, { r: 52, g: 152, b: 219, a: 0.6 }]
  , [{ r: 231, g: 76, b: 60, a: 0.8 }, { r: 241, g: 196, b: 15, a: 0.8 }, { r: 52, g: 152, b: 219, a: 0.8 }]
  , [{ r: 231, g: 76, b: 60, a: 1   }, { r: 241, g: 196, b: 15, a: 1   }, { r: 52, g: 152, b: 219, a: 1   }]
  , [{ r: 231, g: 76, b: 60, a: 1   }, { r: 241, g: 196, b: 15, a: 1   }, { r: 52, g: 152, b: 219, a: 1   }]
  , [{ r: 231, g: 76, b: 60, a: 1   }, { r: 241, g: 196, b: 15, a: 1   }, { r: 52, g: 152, b: 219, a: 1   }]
  , [{ r: 231, g: 76, b: 60, a: 1   }, { r: 241, g: 196, b: 15, a: 1   }, { r: 52, g: 152, b: 219, a: 1   }]
  , [{ r: 192, g: 57, b: 43, a: 1   }, { r: 243, g: 156, b: 18, a: 1   }, { r: 41, g: 128, b: 185, a: 1   }]
  , [{ r: 192, g: 57, b: 43, a: 0.8 }, { r: 243, g: 156, b: 18, a: 0.8 }, { r: 41, g: 128, b: 185, a: 0.8 }]
  , [{ r: 192, g: 57, b: 43, a: 0.6 }, { r: 243, g: 156, b: 18, a: 0.6 }, { r: 41, g: 128, b: 185, a: 0.6 }]
  , [{ r: 192, g: 57, b: 43, a: 0.4 }, { r: 243, g: 156, b: 18, a: 0.4 }, { r: 41, g: 128, b: 185, a: 0.4 }]
], {
    pixels: ["######", "888888", "@@@@@@"]
  , bg: true
}));
// ##################
// 888888888888888888
// 888888888888888888
// 888888888888888888
// 888888888888888888
// 888888888888888888
// 888888888888888888
// 888888888888888888
// 888888888888888888
// ######888888888888
// ##################

:question: 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. :bug:
  3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

asciifyMatrix(pixels, options)

Params

  • Matrix pixels: The pixels matrix (array of arrays of pixel objects).
  • Object options: An object to pass to asciify-pixel extended with the following fields:
  • stringify (Boolean): If false, the pixel objects will not be stringified.
  • concat (Boolean): If false, the pixel objects will not be joined together.

Return

  • Matrix|String The result matrix.

stringifyMatrix(input)

Stringifies the matrix.

Params

  • Matrix input: A matrix of pixels returned by the asciify-pixel package.

Return

  • String The stringified matrix.

stringify(input)

Stringifies the input pixels.

Params

  • Matrix input: A matrix of pixels returned by the asciify-pixel package.

Return

  • Matrix A matrix of characters (the stringified pixel objects).

join(input)

Joins the matrix characters.

Params

  • Matrix input: A matrix of characters (the stringified pixel objects).

Return

  • String The stringified matrix.

:yum: How to contribute

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

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to 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 :rocket:
  • Buy me a book—I love books! I will remember you after years if you buy me one. :grin: :book:
  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:
  • Support me on Patreon—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

    npm.io

Thanks! :heart:

:dizzy: Where is this library used?

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

  • image-to-ascii
  • bundle-buddy-webpack-plugin
  • jimthedev-bundle-buddy-webpack-plugin
  • bronos
  • bundle-buddy-webpack-plugin-next

:scroll: License

MIT © Ionică Bizău

1.0.14

4 years ago

1.0.13

6 years ago

1.0.12

7 years ago

1.0.11

7 years ago

1.0.10

7 years ago

1.0.9

7 years ago

1.0.8

7 years ago

1.0.7

7 years ago

1.0.6

8 years ago

1.0.5

8 years ago

1.0.4

8 years ago

1.0.3

8 years ago

1.0.2

8 years ago

1.0.1

8 years ago

1.0.0

8 years ago