RomanNum3ral
/
ascii-image-converter
mirror of https://github.com/TheZoraiz/ascii-image-converter.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ascii-image-converter/README.md

2.5 KiB
Raw Blame History

ascii-image-converter

ascii-image-converter is a command-line tool that converts images into ascii art and prints them out onto the console. It is cross-platform so both Windows and Linux distributions are supported

Currently, the tool supports PNG, JPEG/JPG, WEBP and BMP image formats

Installation

First download the executables from here, and follow the steps with respect to your OS.

Linux

Extract Executables.zip and open the "Linux" directory.

Now, open a terminal in the same directory and execute this command:

sudo cp ascii-image-converter /usr/local/bin/

Now you can use ascii-image-converter in the terminal. Execute "ascii-image-converter -h" for more details.

Windows

Extract Executables.zip and open the "Windows" folder. Copy the path to folder from the top of the file explorer and follow these instructions:

  • In Search, search for and then select: System (Control Panel)
  • Click the Advanced system settings link.
  • Click Environment Variables. In the section User Variables find the Path environment variable and select it. Click "Edit".
  • In the Edit Environment Variable window, click "New" and then paste the path of the folder that you copied initially.
  • Afterwards, you can use it anywhere by typing "ascii-image-converter" in command prompt. Note: Make sure you restart the command prompt.

Usage

To convert an image into ascii format, the usage is as follows:

ascii-image-converter [path to image]

Example

ascii-image-converter myImage.jpeg

Flags

--complex OR -c

Print the image with a wider array of ascii characters. Sometimes improves accuracy.

ascii-image-converter [path to image] -c

--dimensions OR -d

Set the width and height of the printed ascii image in character lengths.

ascii-image-converter [path to image] -d <width>,<height>
# Or
ascii-image-converter [path to image] --dimensions <width>,<height>

Example:

ascii-image-converter [path to image] -d 100,30

--save OR -S

Save the image ascii art in a file ascii-image.txt in the same directory

ascii-image-converter [path to image] --save
# Or
ascii-image-converter [path to image] -S

You can combine commands as well

ascii-image-converter [path to image] -Scd 100,30

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

Apache-2.0