https://github.com/sanalzio/pixcii

Free image to ASCII text converter software.
https://github.com/sanalzio/pixcii

ascii ascii-art cli command-line free free-software gpl3 gplv3 javascript jimp js node node-js nodejs

Last synced: about 1 month ago
JSON representation

Free image to ASCII text converter software.

• Host: GitHub
• URL: https://github.com/sanalzio/pixcii
• Owner: sanalzio
• License: gpl-3.0
• Created: 2024-01-22T08:09:43.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-02-15T06:02:46.000Z (10 months ago)
• Last Synced: 2024-02-16T06:39:04.925Z (10 months ago)
• Topics: ascii, ascii-art, cli, command-line, free, free-software, gpl3, gplv3, javascript, jimp, js, node, node-js, nodejs
• Language: JavaScript
• Homepage:
• Size: 48.8 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# PixCii

![NodeJS](https://img.shields.io/badge/Node.JS-%23378D3B.svg?style=for-the-badge&logo=node.js&logoColor=white) ![Node Version](https://img.shields.io/static/v1?label=Version&message=18.18.0&style=for-the-badge&labelColor=4BAE4F&color=2E7D32&logo=node.js&logoColor=ffffff) ![LICENSE](https://img.shields.io/static/v1?label=LICENSE&message=GPL-V3&style=for-the-badge) [](https://github.com/sanalzio/PixCii/releases)

**Free image to ASCII text converter software.**

[What is the free software?](https://en.wikipedia.org/wiki/Free_software)

```

                     PixCii X.X.X

    Simple "open-source" image to ASCII text converter.

    Usage: ./pixcii <*input_file_path> 

    Or you can simply drag and drop the files you want to cut into executable file.

    Arguments:

    --help or -h: show undetailed help menu.

    --deatiledhelp or -dh: show this menu.

    --out: set output file path.

    Usage: --out 

    --size: resize image to specified width and height.

    Usage: --size  

    -r: reverse the ascii characters.

    -l: print the ascii text to the console.

    -i: disable write info to console.

    -w: removes the whitespaces.

    -s: disable the resizing performed to maintain the aspect ratio..

    +: run specified JIMP function before converting to ascii.

    Example: +resize(90,24)

    --exec: execute the specified javascript code.

    Usage: --exec ""

    --onconed: execute the specified javascript code on converted.

    Example: --onconed ""

    --onsvd: execute the specified javascript code on saved.

    Example: --onsvd ""

    --onst: execute the specified javascript code on start.

    Example: --onst ""

    --befcon: execute the specified javascript code before converting.

    Example: --befcon ""

    --execcmd: execute the specified Shell code.

    Usage: --execcmd ""

```

- [PixCii](#pixcii)

  - [Istallation](#istallation)

  - [Build](#build)

  - [Usage](#usage)

    - [Run like this:](#run-like-this)

    - [Examples](#examples)

  - [Scripting](#scripting)

    - [Using --exec Argument](#using---exec-argument)

    - [Using runCmd Function](#using-runcmd-function)

    - [Using --execcmd Argument](#using---execcmd-argument)

  - [License](#license)

## Istallation

[](https://github.com/sanalzio/PixCii/releases)

Download PixCii latest relase from [here](https://github.com/sanalzio/PixCii/releases). Or  you can [build](#build) from source. 

## Build

```bash

git clone https://github.com/sanalzio/PixCii

cd PixCii

npm install

node index.js

```

## Usage

### Run like this:

```bash

pixcii  

```

> [!TIP]

> **Or you can simply drag and drop the files you want to cut into executable file**

### Examples

```bash

pixcii image.png

pixcii image.png --size 100 50 -r --out output.txt

pixcii image.png --size 100 50 -riws

pixcii image.png --size 100 50 -rl

pixcii image.png --size 100 50 --exec "console.log(\"Done ✔\");"

```

## Scripting

You can use scripting to execute JavaScript code or execute Shell code. For better information look Detailed Information.

### Using --exec Argument

```bash

pixcii image.png --exec "console.log(\"Hello World! from --exec arg\");"

```

Output: Hello World! from --exec arg

### Using runCmd Function

```bash

pixcii image.png --exec "runCmd(\"Hello World! from runCmd function\");"

```

Output: Hello World! from runCmd function

### Using --execcmd Argument

```bash

pixcii image.png --execcmd "echo Hello World! from --execcmd arg"

```

Output:  Hello World! from --execcmd arg

## License

[GPL-V3](https://www.gnu.org/licenses/gpl-3.0.en.html#license-text)