ploMP4/chafa-go
ploMP4/chafa-go has 56 GitHub stars and 3 forks. GitHot measured 0 stars in 24 hours and 0 in 7 days. Last checked 2026-11-15 21:09 UTC. Last push 2026-10-30.
Measured star growth
- in 24h
- 0
- in 7 days
- 0
- in 15 days
- Update delayed
- in 1 month
- Update delayed
Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.
About
Go bindings for the Chafa terminal graphics library. Render high quality images on the terminal without CGO or external dependencies.
Developer ToolsREADME.md
Originalchafa-go
chafa-go provides Go bindings for the Chafa C library using purego, meaning no CGO is required. Chafa is a powerful image-to-text converter for terminal graphics, supporting a variety of character sets, color modes, and dithering options.
There are precompiled libchafa shared objects embedded in the repository using Go’s embed feature.
These binaries are automatically built from the official Chafa source and committed via a GitHub Action.
At runtime, the correct binary for your platform is selected and loaded dynamically.
Currently Supported Platforms:
- linux/amd64
- linux/386
- darwin/arm64
- windows/amd64
Installation
go get github.com/ploMP4/chafa-go
Usage
Basic usage is shown below. For more complete examples, see the examples/ directory.
package main
import (
"fmt"
"github.com/ploMP4/chafa-go"
)
const (
PixWidth = 3
PixHeight = 3
NChannels = 4
)
func main() {
pixels := []uint8{
0xff, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, 0xff, 0xff, 0x00, 0x00, 0xff,
0x00, 0x00, 0x00, 0xff, 0xff, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, 0xff,
0xff, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00, 0xff, 0xff, 0x00, 0x00, 0xff,
}
// Specify the symbols we want
symbolMap := chafa.SymbolMapNew()
defer chafa.SymbolMapUnref(symbolMap)
chafa.SymbolMapAddByTags(symbolMap, chafa.CHAFA_SYMBOL_TAG_ALL)
// Set up a configuration with the symbols and the canvas size in characters
config := chafa.CanvasConfigNew()
defer chafa.CanvasConfigUnref(config)
chafa.CanvasConfigSetGeometry(config, 40, 20)
chafa.CanvasConfigSetSymbolMap(config, symbolMap)
// Create canvas
canvas := chafa.CanvasNew(config)
defer chafa.CanvasUnRef(canvas)
// Draw pixels to canvas
chafa.CanvasDrawAllPixels(
canvas,
chafa.CHAFA_PIXEL_RGBA8_UNASSOCIATED,
pixels,
PixWidth,
PixHeight,
PixWidth*NChannels,
)
// Generate a string that will show the canvas contents on a terminal
gs := chafa.CanvasPrint(canvas, nil)
fmt.Println(gs)
}
Animated GIFs
Run the playback example from the repository root in an ANSI terminal:
go run ./examples/gif -width 80 -height 24 path/to/animation.gif
The example preserves the aspect ratio, uses the GIF's frame delays and loop
count, and restores the terminal when it finishes or you press Ctrl+C. Use
-once to play a looping GIF once. GIFs with no frame delay use 50 ms in this
example. Set the width and height to fit your terminal; output uses character
symbols and the terminal's detected color mode.
For your own player, chafa.LoadGIF(path) returns an Animation containing
fully composited RGBA8 frames, their time.Duration delays, the logical screen
size, and the loop count. All frames are loaded into memory. Draw each frame's
Pixels with CanvasDrawAllPixels, CHAFA_PIXEL_RGBA8_UNASSOCIATED, and a
rowstride of animation.Width * 4. CanvasPrintString returns Go-owned terminal
output and releases its native buffers, making it suitable for continuous
playback. Load continues to return just the first frame of a GIF.
Contributing
All contributions are welcome! If you're planning a significant change or you're unsure about an idea, please open an issue first so we can discuss it in detail.