# asciificator

> Convert your images into ASCII Art

Latest version **0.1.0** (published 2020-05-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install asciificator
pnpm add asciificator
yarn add asciificator
bun add asciificator
```

Provides the command `asciificator`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2020-05-15 |
| First published | 2020-05-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Yash Shah |
| Maintainers | yashshah1 |
| Keywords | ascii, image |

## Links

- npm: https://www.npmjs.com/package/asciificator
- Repository: https://github.com/yashshah1/asciificator
- Homepage: https://github.com/yashshah1/asciificator#readme
- Issues: https://github.com/yashshah1/asciificator/issues
- npm.io page: https://npm.io/package/asciificator

## Dependencies (2)

- [jimp](https://npm.io/package/jimp.md) ^0.10.3
- [commander](https://npm.io/package/commander.md) ^5.1.0

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2020-05-15

## README

```
                        .__ .__   _____ .__                   __
_____     ______  ____  |__||__|_/ ____\|__|  ____  _____   _/  |_   ____  _______
\__  \   /  ___/_/ ___\ |  ||  |\   __\ |  |_/ ___\ \__  \  \   __\ /  _ \ \_  __ \
 / __ \_ \___ \ \  \___ |  ||  | |  |   |  |\  \___  / __ \_ |  |  (  <_> ) |  | \/
(____  //____  > \___  >|__||__| |__|   |__| \___  >(____  / |__|   \____/  |__|
     \/      \/      \/                          \/      \/
```

# Asciificator

A really dumb tool (without a programatic usage) that converts your images into ASCII art :P

# Install

`npm i -g asciificator`

# Usage

```
$ asciificator -h
Usage: asciificator [options]

Options:
  -V, --version             output the version number
  -i, --input-file <file>   Path to input file
  -o, --output-file <file>  Name of output file (default: null)
  --image-width <width>     Width of ouput ASCII art (default: 100)
  --image-height <height>   Width of ouput ASCII art (default: null)
  --red-weight <weight>     Red Weight for B/w (default: 0.3)
  --green-weight <weight>   Green Weight for B/w (default: 0.578)
  --blue-weight <weight>    Blue Weight for B/w (default: 0.122)
  -h, --help                display help for command
```

## Usage

```
# print it to console
$ asciificator -i <path-or-url-to-image>

# to write it to a file:
$ asciificator -i <path-to-image> -o <path-to-file>
$ asciificator -i <path-to-image> > path-to-file # alternate
```

# Contributing

Real help is needed in porting this to have prgramatic usage.<br />
Feel free to fork and make a PR.

---
_Source: https://npm.io/package/asciificator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._