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
A cross-platform command-line tool to convert images into ascii art and print them on the console. Now supports braille art!
9 Commits 1 Branch 34 Tags 32 MiB
Go 100%
Go to file
Zoraiz cb00a9cce5 Updated README.md 2021-05-12 03:03:29 +05:00
cmd Added WEBP and BMP support and added README.md 2021-05-12 02:00:42 +05:00
example_images Added example images 2021-05-12 02:41:26 +05:00
image_manipulation Added WEBP and BMP support and added README.md 2021-05-12 02:00:42 +05:00
.gitignore First Commit 2021-05-11 23:55:58 +05:00
LICENSE First Commit 2021-05-11 23:55:58 +05:00
README.md Updated README.md 2021-05-12 03:03:29 +05:00
go.mod Added WEBP and BMP support and added README.md 2021-05-12 02:00:42 +05:00
go.sum Added WEBP and BMP support and added README.md 2021-05-12 02:00:42 +05:00
main.go Changed console size calculation package for cross-platform 2021-05-11 19:59:01 +05:00

README.md

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


Example (Source)

Example

ASCII Art:

Example


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.

Packges used

github.com/spf13/viper

github.com/spf13/cobra

github.com/mitchellh/go-homedir

github.com/nathan-fiscaletti/consolesize-go

github.com/nfnt/resize

License

Apache-2.0