ascii-image-converter

To install ascii-image-converter on Debian or Ubuntu-based systems using apt, add the repository and install the package using the following commands:

1. Add the repository source.
2. Update the package list.
3. Install the converter.

To remove the package source (disabling future updates), delete the list file in /etc/apt/sources.list.d/.

echo 'deb [trusted=yes] https://apt.fury.io/ascii-image-converter/ /' | sudo tee /etc/apt/sources.list.d/ascii-image-converter.list
sudo apt update
sudo apt install -y ascii-image-converter

Install the converter on Windows using the Scoop package manager.

scoop install ascii-image-converter

To use ascii-image-converter as a Go package in your own projects, install it using go get.

go get -u github.com/TheZoraiz/ascii-image-converter/aic_package

To use the binary manually on Windows:

1. Download the archive for your architecture from the releases page.
2. Extract the folder.
3. Add the folder path to your User Path environment variable via Advanced System Settings > Environment Variables.
4. Restart your command prompt.

To install the binary manually on Linux:

1. Download the archive for your architecture from the releases page.
2. Extract the archive.
3. Move the ascii-image-converter binary to /usr/local/bin/ to make it available in your terminal.

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

For Arch Linux users, you can install the package from the AUR using standard makepkg or an AUR helper.

# Standard way
git clone https://aur.archlinux.org/ascii-image-converter-git.git
cd ascii-image-converter-git/
makepkg -si

# Using an AUR helper
<aur-helper> -S ascii-image-converter-git

If you have Go installed, you can install the tool directly using go install.

go install github.com/TheZoraiz/ascii-image-converter@latest

Install the snap package.

Note: The snap version does not have access to hidden files or files outside the $HOME directory, which affects write access for saving ASCII art.

sudo snap install ascii-image-converter

You can install ascii-image-converter on both Linux and macOS using Homebrew.

brew install TheZoraiz/ascii-image-converter/ascii-image-converter

Import github.com/TheZoraiz/ascii-image-converter/aic_package to convert images programmatically.

Important: For environments without a terminal (like web servers), you MUST specify at least one of flags.Width, flags.Height, or flags.Dimensions.

package main

import (
	"fmt"

	"github.com/TheZoraiz/ascii-image-converter/aic_package"
)

func main() {
	filePath := "myImage.jpeg"

	flags := aic_package.DefaultFlags()

	// Configuration
	flags.Dimensions = []int{50, 25}
	flags.Colored = true
	flags.SaveTxtPath = "."
	flags.SaveImagePath = "."
	flags.CustomMap = " .-=+#@"
	flags.FontFilePath = "./RobotoMono-Regular.ttf"
	flags.SaveBackgroundColor = [4]int{50, 50, 50, 100}

	// Conversion
	asciiArt, err := aic_package.Convert(filePath, flags)
	if err != nil {
		fmt.Println(err)
	}

	fmt.Printf("%v\n", asciiArt)
}