pixterm

README

   ___  _____  ____
  / _ \/  _/ |/_/ /____ ______ _    Made with love by Eliuk Blau
 / ___// /_>  </ __/ -_) __/  ' \   github.com/eliukblau/pixterm
/_/  /___/_/|_|\__/\__/_/ /_/_/_/   v1.1.1

PIXterm - draw images in your ANSI terminal with true color

PIXterm shows images directly in your terminal, recreating the pixels through a combination of ANSI character background color and the unicode lower half block element. If image has transparency, an optional matte color can be used for background.

The conversion process runs fast because it is parallelized in all CPUs.

Supported image formats: JPEG, PNG, GIF, BMP, TIFF, WebP.

Cool Screenshots

Requirements

Your terminal emulator must be support true color feature in order to display image colors in a right way. In addition, you must use a monospaced font that includes the lower half block unicode character ▄ (U+2584). I personally recommend Envy Code R. It's the nice font that shows in the screenshots.

Dependencies

All dependencies are directly included in the project via Go's Vendor Directories. You should not do anything else. Anyway, if you want to get the dependencies manually, project uses the Glide Vendor Package Management. Follow its instructions.

Dependencies for PIXterm CLI tool

• Package colorful: github.com/lucasb-eyer/go-colorful
• Package terminal: golang.org/x/crypto/ssh/terminal

Dependencies for ANSImage Package

• Package imaging: github.com/disintegration/imaging
• Package webp: golang.org/x/image/webp
• Package bmp: golang.org/x/image/bmp
• Package tiff: golang.org/x/image/tiff

Installation

You need the Go compiler version 1.6 or superior installed in your system.

Run this command to automatically download sources and install PIXterm binary in your $GOPATH/bin directory:

go get -u github.com/eliukblau/pixterm

About

PIXterm is a terminal toy application that I made to exercise my skills on Go programming language. If you have not tried this language yet, please give it a try! It's easy, fast and very well organized. You'll not regret :D

This application is inspired by the clever termpix, implemented in Rust.

License

Mozilla Public License Version 2.0

Contributors

• @disq - Original code for image transparency support.
• @timob - Fix for ANSIpixel type: use 8bit color component for output.