https://github.com/askeladdk/aseprite

Aseprite image loader for Go.
https://github.com/askeladdk/aseprite

aseprite ebiten ebitengine go golang

Last synced: 3 months ago
JSON representation

Aseprite image loader for Go.

• Host: GitHub
• URL: https://github.com/askeladdk/aseprite
• Owner: askeladdk
• License: isc
• Created: 2022-09-07T10:36:02.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2026-01-11T11:12:56.000Z (3 months ago)
• Last Synced: 2026-01-11T15:28:47.296Z (3 months ago)
• Topics: aseprite, ebiten, ebitengine, go, golang
• Language: Go
• Homepage:
• Size: 941 KB
• Stars: 24
• Watchers: 2
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Aseprite image loader

[![GoDoc](https://godoc.org/github.com/askeladdk/aseprite?status.png)](https://godoc.org/github.com/askeladdk/aseprite)

[![Go Report Card](https://goreportcard.com/badge/github.com/askeladdk/aseprite)](https://goreportcard.com/report/github.com/askeladdk/aseprite)

[![Coverage Status](https://coveralls.io/repos/github/askeladdk/aseprite/badge.svg?branch=master)](https://coveralls.io/github/askeladdk/aseprite?branch=master)

## Overview

Package aseprite implements a decoder for [Aseprite sprite files](https://github.com/aseprite/aseprite/blob/main/docs/ase-file-specs.md) (`.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`:

```go

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:

```go

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`:

```go

sprite, err := aseprite.Read(f)

```

Read the [documentation](https://pkg.go.dev/github.com/askeladdk/aseprite) 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.