Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khrome/ascii-art
A Node.js library for ansi codes, figlet fonts, ascii art and other ASCII graphics
https://github.com/khrome/ascii-art
ansi-codes ansi-styles ascii ascii-art command-line-tool compositing figlet images javascript tables terminal-graphics
Last synced: 3 months ago
JSON representation
A Node.js library for ansi codes, figlet fonts, ascii art and other ASCII graphics
- Host: GitHub
- URL: https://github.com/khrome/ascii-art
- Owner: khrome
- License: mit
- Created: 2012-12-11T05:00:03.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2021-07-30T03:04:42.000Z (over 3 years ago)
- Last Synced: 2024-05-29T20:57:01.575Z (5 months ago)
- Topics: ansi-codes, ansi-styles, ascii, ascii-art, command-line-tool, compositing, figlet, images, javascript, tables, terminal-graphics
- Language: JavaScript
- Size: 3.94 MB
- Stars: 680
- Watchers: 13
- Forks: 286
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hacking-lists - khrome/ascii-art - A Node.js library for ansi codes, figlet fonts, ascii art and other ASCII graphics (JavaScript)
- awesome-ascii - ascii-art
README
_ _ _
(_)(_) | |
__ _ ___ ___ _ _ ______ __ _ _ __ | |_
/ _` |/ __| / __|| || ||______| / _` || '__|| __|
| (_| |\__ \| (__ | || | | (_| || | | |_
\__,_||___/ \___||_||_| \__,_||_| \__|
ascii-art.js
============
[]()
[]()
[]()
[](https://github.com/khrome/ascii-art)
Images, fonts, tables, ansi styles and compositing in Node.js & the browser. 100% JS. ([What is ASCII-Art?](https://github.com/khrome/ascii-art-docs/blob/master/History.md))
In the beginning there was [colors.js](https://github.com/Marak/colors.js) but in the fine tradition of vendors calling out a problem they have the solution to, [chalk](https://github.com/yeoman/yo/issues/68) was introduced. In that same vein, I offer `ascii-art` as an update, expansion and generalization of [MooAsciiArt](http://mootools.net/forge/p/mooasciiart) and at the same time it can replace your existing ansi colors library.
It features support for [Images](https://www.npmjs.com/package/ascii-art-image), [Styles](https://github.com/khrome/ascii-art-docs/blob/master/Styles.md), [Tables](https://www.npmjs.com/package/ascii-art-table), [Graphs](https://www.npmjs.com/package/ascii-art-graph) and [Figlet Fonts](https://www.npmjs.com/package/ascii-art-font) as well as handling multi-line joining and compositing automatically.
Why would I use this?
[click to expand/close]
- **modular** - small set of purpose built modules all interacting through a common ansi library.
- **color profiles** support - other libraries mostly assume you are running x11.
- **no prototype manipulation** - No `String.prototype` usage. No `__proto__` usage. No BS.
- handles the ugly [intersection of **multiline text and ansi codes**](https://github.com/khrome/ascii-art-docs/blob/master/Multiline.md) for you.
- runs in the **browser and Node.js** (CommonJS, AMD, globals, webpack, or webcomponents)
- **Other libraries** out there **do too little**, focus on logging and have inconsistent ANSI handling *.
- **JS + Canvas** No binaries... we are 100% JS, with a common code path in browser and server †.
- It **works like a package manager** for figlet fonts.
- **flexible output** Supports 4bit, 8bit and 32bit output
- **Supports your existing API** We allow you to use the colors.js/chalk API *or* our own ‡.
* - Example: Style text, then put it in a table. It displays based on it's ansi string width, but balances cell widths based on the string width, leading to crazy looking output.
† - This allows us plug into averaging, distance and other logic dynamically, in powerful ways (In node this renders in cairo, via a Canvas shim)
‡ - while both have fluent apis we use a grid and are asynchronous, which enables large image processing and complex compositing scenarios, whereas the chalk API focuses on immediate string mutations
Installation
------------
`ascii-art` supports many usage styles, but the different use cases require slightly different installations. If you have any questions, please ask.
In Code
```bash
npm install --save ascii-art
```
CLI
```bash
npm install -g ascii-art
```
or (Beta):
```bash
npm install -g ascii-art-cl
```
Web
```bash
npm install --save ascii-art-webcomponents
```
Call Style
----------
All chains in `ascii-art` can be called in one of 3 ways. In this example we change "Some Text" to be formatted using the `doom.flf` font.
Callback
```javascript
art.font("Some Text", 'doom', (err, rendered)=>{
//if err, err is the error that occured
//if !err rendered is the ascii
});
```
Promise
```javascript
art.font("Some Text", 'doom')
.then((rendered)=>{
//rendered is the ascii
})).catch((err)=>{
//err is an error
}));
```
Await
```javascript
try{
let rendered = await art.font("Some Text", 'doom').completed()
//rendered is the ascii
}catch(err){
//err is an error
}
```
Styles
------
Add ANSI styles to a string and return the result.
Change "Some Text" to be formatted with ansi codes for `green` (then have the colors reset at the end of the string)
JS
```javascript
art.style("Some Text", 'green', true) //returns String
```
CL
```bash
ascii-art text -s green "Some Text"
```
Web
```html
Some Text
```
Styles are: *italic*, **bold**, underline, |framed|, |encircled|, overline, blink and inverse . And available colors are:
**Colors**
Color defaults to 8 bit (most compatible), to enable other modes set booleans in the options:
- `is256` : compute the color using 256colors, as defined by ansi256. Note that full color output may need to tune the difference method to obtain optimal results.
- `isTrueColor` : do not constrain color and directly output RGB to the console.
Color Tables may be found in the style [documentation](https://github.com/khrome/ascii-art-docs/blob/master/Styles.md)
Fonts
-----
Render a string using a figlet font and add that to the buffer. There is a batch version of this function which does not chain and takes an array( `.strings()`).
Change "Some Text" to be formatted using the `doom.flf` font, which it will load from the predefined location (defaults to `/Fonts`)
JS
```javascript
art.font("Some Text", 'doom', true) //returns String
```
CL
```bash
ascii-art font -F doom "Some Text"
```
Web
```html
Some Text
```
Outputs
______ _
| _ \ | |
| | | | ___ _ __ ___ ___ | |
| | | | / _ \| '_ ` _ \ / _ \ | |
| |/ / | __/| | | | | || (_) ||_|
|___/ \___||_| |_| |_| \___/ (_)
### UTF Fonts
If you use UTF fonts(Which are part of your system fonts) your output looks more like:
 or  by using `u:` where the font names are: `default`, `script`, `script+bold`, `gothic`, `gothic+bold`, `serif+bold+italic`, `serif+bold`, `serif+italic`, `monospace`, `sansserif`, `sansserif+bold+italic`, `sansserif+bold`, `sansserif+italic`, `doublestrike`
Check out the [documentation](https://www.npmjs.com/package/ascii-art-font) for more examples!
Images
------
Create an image from the passed image and append that to the buffer
This takes `myImage.jpg`, converts the colors to ansi backgrounds and then stipples the details at a threshold of 40 (of 255) using a higher resolution image and then renders that into a braille overlay in black(#000000) on top of the colors.
JS
```javascript
art.image({
src: "myImage.jpg",
rows:80,
cols:80,
stipple:"#000000",
posterize: true,
threshold:40
}, cb)
```
CL
```bash
ascii-art image posterized stippled
--rows=80 --cols=80 --stipple="#000000"
--threshold=40 myImage.jpg
```
Web
```html
```
There are some options that are available which are not in the [image core](https://www.npmjs.com/package/ascii-art-image), they are:
- `lineart` : A boolean option which outputs lineart using block characters (which may be colored with `stroke` and customized with `threshold`(0-255)). Example
- `stipple` : A boolean option which outputs lineart using braille characters (which may be colored with `stroke` and customized with `threshold`(0-255)). Example
- `posterize` : Use stipple on top of colored backgrounds to retain as much detail as possible. Example
- `blended` : Use posterize with both lineart and braille at relative thresholds to each other. Example
### Downsampling and detail loss
Because of the [resolution downsampling](https://en.wikipedia.org/wiki/Pixel#Sampling_patterns) from the [original dimensions](https://en.wikipedia.org/wiki/Image_resolution#Pixel_count) to the [destination width](https://en.wikipedia.org/wiki/Characters_per_line), some finer details may be lost. Plan accordingly. Here's an example of [some sequential art](https://en.wikipedia.org/wiki/Grendel_(comics)) in 256 color (primarily greyscale):
Example
JS
```javascript
var art = require('ascii-art');
var Color = require('ascii-art-ansi/colors');
Color.is256 = true;
art.image({
src: "node_modules/ascii-art/Images/grendel.jpg",
alphabet:"blocks"
}, cb);
```
CL
```bash
ascii-art image
-B 8
-C rankedChannel
-a blocks
node_modules/ascii-art/Images/grendel.jpg
```
Web
```html
```
### Color Modes
Multiple output modes are available including [4bit](https://en.wikipedia.org/wiki/Color_depth#4-bit_color), [8bit](https://en.wikipedia.org/wiki/8-bit_color), [32bit](https://en.wikipedia.org/wiki/Color_depth#Deep_color_(30-bit)) (equivalent to [24bit](https://en.wikipedia.org/wiki/Color_depth#True_color_(24-bit))). [16bit](https://en.wikipedia.org/wiki/Color_depth#High_color_(15/16-bit)) color was intentionally excluded, as there is no direct terminal support and the cost of including color definitions for such a large set would not be justified. It would be feasible to implement as an optional import, should the need exist.
The following example takes [`zero-cool.jpg`](https://www.youtube.com/watch?v=2efhrCxI4J0), converts the colors to ansi foreground color in solid block characters. Note that you will need to tune your distance function in 8bit mode, as what looks good varies by the type of imagery that goes through it.
Anecdotally, the default distance function only covers ~1/3 of the samples we've done, but we support many methods(`euclideanDistance`, `classic`, `ratioDistance`, `classicByValue`, `CIE76Difference`, `closestByIntensity`, `rankedChannel`, `simple`, `minDeviation`, `luminosity`, `saturation`, `hue`, `original`). But helpfully, you can merge algorithms by asking for `algorithm1+algorithm2` (it uses equal weighting), or make your own.
img
4
8
32
JS
4
```javascript
var art = require('ascii-art');
art.image({
src: "node_modules/ascii-art/Images/zero-cool.jpg",
alphabet:"solid"
}, cb);
```
8
```javascript
var art = require('ascii-art');
var Color = require('ascii-art-ansi/colors');
Color.is256 = true;
art.image({
src: "node_modules/ascii-art/Images/zero-cool.jpg",
alphabet:"solid"
}, cb);
```
32
```javascript
var art = require('ascii-art');
var Color = require('ascii-art-ansi/colors');
Color.isTrueColor = true;
art.image({
src: "node_modules/ascii-art/Images/zero-cool.jpg",
alphabet:"solid"
}, cb);
```
CL
4
```bash
ascii-art image
-B 4
-a solid
node_modules/ascii-art/Images/zero-cool.jpg
```
8
```bash
ascii-art image
-B 8
-C closestByIntensity
-a solid
node_modules/ascii-art/Images/zero-cool.jpg
```
32
```bash
ascii-art image
-B 32
-a solid
node_modules/ascii-art/Images/zero-cool.jpg
```
Web
4
```html
```
8
```html
```
32
```html
```
Check out the [documentation](https://www.npmjs.com/package/ascii-art-image) for more examples!
Tables
------
Generate a table from the passed data, with support for many styles and append that to the buffer
Render a table for with the provided data given the provided options
JS
```javascript
art.table({}, cb) //returns String
```
CL
```bash
# N/A
```
Web
```html
```
Check out the [documentation](https://www.npmjs.com/package/ascii-art-table) for more examples!
Graphs
------
Render a graph for with the provided data given the provided options
JS
```javascript
art.graph({}, cb) //returns String
```
CL
```bash
# N/A
```
Web
```html
```
Check out the [documentation](https://www.npmjs.com/package/ascii-art-graph) for more examples!
Artwork[Non-Functional]
-------
Fetch a graphic from a remote source and append it to the current buffer, which is not enabled by default. You must add a `request` compatible library by either setting the ENV variable `ASCII_ART_REQUEST_MODULE` **or** by setting it manually with `art.setRequest(requestModule)`
Fetch artwork from the requested source using the preconfigured request library.
JS
```javascript
art.artwork({}, cb) //returns String
```
CL
```bash
# N/A
```
Web
```html
```
Often I use this in conjunction with an image backdrop, for example to superimpose bones on the earth:
Compositing
-----------
We also support combining all these nifty elements you've made into a single composition, via a few functions available on the chains (`.lines()`, `.overlay()`, `.border()`, `.strip()` and `.join()`). Maybe I've got A BBS wall I want to have some dynamic info on.. I could make that with [this](test/scripts/bbs.js)
Check out the [documentation](https://github.com/khrome/ascii-art-docs/blob/master/Compositing.md) for detailed examples!
Compatibility
-------------
If you're a [chalk](https://www.npmjs.com/package/chalk) user, just use `var chalk = require('ascii-art/kaolin');` in place of your existing `chalk` references (Much of color.js, too... since chalk is a subset of colors.js). No migration needed, keep using the wacky syntax you are used to(In this mode, refer to their docs, not mine).
Users of [ascii-table](https://www.npmjs.com/package/ascii-table) will also note that interface is supported via `require('ascii-art').Table`, though our solution is ansi-aware, lazy rendering and better at sizing columns.
I may support the other [colors](https://www.npmjs.com/package/colors) stuff (extras & themes) eventually, but it's currently a low priority.
Roadmap
-------
#### Goals
- Re-enable `.artwork()`
- Bring karma current, deprecate phantomjs
- artwork source standard
- Better Docs
- value reversal (light vs dark)
- HTML output
- piping support on the command line
- [ATASCII art](https://en.wikipedia.org/wiki/ATASCII) support
- [ANSI art](https://en.wikipedia.org/wiki/ANSI_art) support
- [PETSCII art](https://en.wikipedia.org/wiki/PETSCII) support
- 2 colors per char with multisampling
- Graph enhancements
- REPL
#### Non Goals
- realtime: videos, curses, etc.:
- logging integration
Testing
-------
In the root directory run:
npm run test
which runs the test suite directly. In order to test it in Chrome try:
npm run browser-test
In order to run the chalk test, use:
npm run chalk-test
Deprecations
------------
- `.artwork()` is currently non-functional while we enable an open-plugin standard, which will arrive shortly. When it does, you'll be able to plug any number of fetch solutions in, which hopefully matches whatever you currently bundle.
- `.toPromise()` is now deprecated in favor of `.completed()` and will be removed when 3.x arrives
- up to this point all files are UMD wrapped and may be used *without modification* in node(even old versions), the browser and via browser build systems. when 3.x arrives, the UMD versions may be part of an independent build process, while the mainline browser and node versions may continue to be uniform. If you have opinions on this, I'd like to hear them.
Development
-----------
**How to dev : the simple version**
- fork `ascii-art`
- `git clone [email protected]:/ascii-art.git`
- go into the checked out module `cd ascii-art`
- execute `./test/dev_setup.sh` (this will install a number of dependencies in the parent directory)
**How to dev : a better version**
- Fork all the ascii-art-modules(`ascii-art-image`, `ascii-art-ansi`, `ascii-art-braille`, `ascii-art-docs`, `ascii-art-font`, `ascii-art-utf`, `ascii-art-graph`, `ascii-art-table`), along with the root module.
- `git clone [email protected]:/ascii-art.git`
- go into the checked out module `cd ascii-art`
- `./dev_setup.sh `
- commit to your own branches master, then submit PRs from that to the master branch of the main repo.
After setup, run `npm test` to make sure everything is working correctly.
Note various modern editions of npm nuke links each time `package-lock.json` is written (which, depending on your settings, may be every new dependency you add). This can be remedied by executing `npx module-auto-link -c 'npm-auto-link'` in the module in question, which will restore it's links.
Please make sure to run the tests before submitting a patch and report any rough edges. Thanks!
Enjoy,
-Abbey Hawk Sparrow