animate

Animate

Animate is a simple sprite animation module made to work with Ebitengine.

Check Out the Example

go run github.com/KalebHawkins/animate/examples/basic@latest

Installation

Add the package to your project.

go get github.com/KalebHawkins/animate

Import the package into your project.

import (
    "github.com/KalebHawkins/animate"
)

Usage

Before scrolling through the readme, I highly recommend looking through the example to get a better idea of how to use this module.

To start off, allocate a slice of Animations. After that, you will define each animation. Then append individual animations to your slice.

// Allocate a slice to hold animation definitions.
animations := make(animate.Animations, 0)

// Define each animation.
idleAnimation := &animate.Animation{
    StartFrame: image.Rectangle{
        Min: image.Point{
            X: 0,
            Y: 0,
        },
        Max: image.Point{
            X: 32,
            Y: 32,
        },
    },
    FrameCount: 5,
    Speed:      8,
    Direction:  animate.Horizontal,
}

lookBehind := &animate.Animation{
    StartFrame: image.Rectangle{
        Min: image.Point{
            X: 0,
            Y: 32,
        },
        Max: image.Point{
            X: 32,
            Y: 32,
        },
    },
    FrameCount: 14,
    Speed:      8,
    Direction:  animate.Horizontal,
}

Once the animations are defined you can create an Animator. The Animator is responsible for playing, pausing, and resuming animations. Once declared, add your animations to the animator instance.

// Declare your animator.
animator := animate.NewAnimator()

// Add your animations. animator.Add() will return an error message if the 
// animation name already exists within that instance.
if err := animator.Add("idle", idleAnimation); err != nil {
    panic(err)
}

if err := animator.Add("look", lookBehind); err != nil {
    panic(err)
}

Now call your animator's Play() method every frame.

func (g *Game) Update() error {
    animator.Play("idle")
}

To stop the currently selected animation then use the Pause() method.

animator.Pause()

If you want to toggle an animation you can do so using the sample below.

if inpututil.IsKeyJustReleased(ebiten.KeySpace) {
    if animator.Paused() {
        animator.Resume()
    } else {
        animator.Pause()
    }
}

Spritesheet was created by Elthen's Pixel Art Shop.