https://github.com/hectorm/chafa-wasm
Chafa WebAssembly module to convert images to text.
https://github.com/hectorm/chafa-wasm
ansi ansi-art ascii ascii-art chafa images terminal terminal-graphics unicode unicode-art
Last synced: about 1 year ago
JSON representation
Chafa WebAssembly module to convert images to text.
- Host: GitHub
- URL: https://github.com/hectorm/chafa-wasm
- Owner: hectorm
- License: lgpl-3.0
- Created: 2023-12-04T19:49:45.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-14T16:22:24.000Z (about 1 year ago)
- Last Synced: 2025-04-15T16:59:41.711Z (about 1 year ago)
- Topics: ansi, ansi-art, ascii, ascii-art, chafa, images, terminal, terminal-graphics, unicode, unicode-art
- Language: JavaScript
- Homepage: https://hectorm.github.io/chafa-wasm/
- Size: 20.4 MB
- Stars: 27
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Chafa WebAssembly module
Have you ever wanted to convert an image into a much less efficient and lower quality text representation? No? Well, with this module you can.
With this [Chafa](https://hpjansson.org/chafa/) port to WebAssembly you can convert an image into various text formats like ANSI escape codes, HTML or `console.log` arguments in Node.js, Deno, Bun and web browsers.
This module uses [Emscripten/Embind](https://emscripten.org) to expose low-level bindings of [libchafa](https://hpjansson.org/chafa/ref/) and also includes a higher-level API for the most common scenarios, see the [`docs/`](docs/README.md) directory for details.
If you just want to play with the parameters interactively, a demo application is also available [here](https://hectorm.github.io/chafa-wasm/).
## Usage
### Installation
```sh
npm install chafa-wasm
```
### Example code
```js
import { promises as fs } from "node:fs";
import { promisify } from "node:util";
import { stdout } from "node:process";
import Chafa from "chafa-wasm";
const chafa = await Chafa();
const imageToAnsi = promisify(chafa.imageToAnsi);
const image = await fs.readFile("./example.png");
const { ansi } = await imageToAnsi(image.buffer, {
// Default values:
format: chafa.ChafaPixelMode.CHAFA_PIXEL_MODE_SYMBOLS.value,
height: 25,
fontRatio: 0.5,
colors: chafa.ChafaCanvasMode.CHAFA_CANVAS_MODE_TRUECOLOR.value,
colorExtractor: chafa.ChafaColorExtractor.CHAFA_COLOR_EXTRACTOR_AVERAGE.value,
colorSpace: chafa.ChafaColorSpace.CHAFA_COLOR_SPACE_RGB.value,
symbols: "block+border+space-wide-inverted",
fill: "none",
fg: 0xffffff,
bg: 0x000000,
fgOnly: false,
dither: chafa.ChafaDitherMode.CHAFA_DITHER_MODE_NONE.value,
ditherGrainWidth: 4,
ditherGrainHeight: 4,
ditherIntensity: 1.0,
preprocess: true,
threshold: 0.5,
optimize: 5,
work: 5,
});
stdout.write(ansi);
```