askeladdk / aseprite

Aseprite image loader for Go.

Aseprite image loader

Overview

Package aseprite implements a decoder for Aseprite sprite files (.ase and .aseprite files).

Layers are flattened, blending modes are applied, and frames are arranged on a single texture atlas. Invisible and reference layers are ignored.

Limitations:

• Tilemaps are not supported.
• External files are not supported.
• Old aseprite format is not supported.
• Color profiles are ignored.

Install

go get -u github.com/askeladdk/aseprite

Quickstart

Use image.Decode to decode an aseprite sprite file to an image.Image:

import (
    _ "github.com/askeladdk/aseprite"
)

img, imgformat, err := image.Decode("test.aseprite")

This is enough to decode single frame images. Multiple frames are arranged as a texture atlas in a single image. Type cast the image to aseprite.Aseprite to access the frame data, as well as other meta data extracted from the sprite file:

if imgformat == "aseprite" {
    sprite := img.(*aseprite.Aseprite)
    for _, frame := range sprite.Frames {
        // etc ...
    }
}

Alternatively, use the Read function to directly decode an image to aseprite.Aseprite:

sprite, err := aseprite.Read(f)

Read the documentation for more information about what meta data is extracted.

License

Package aseprite is released under the terms of the ISC license.

The internal blend package is released by Guillermo Estrada under the terms of the MIT license: http://github.com/phrozen/blend.