Skip to content

README.md

Latest commit

 

History

History
99 lines (71 loc) · 2.23 KB

README.md

File metadata and controls

99 lines (71 loc) · 2.23 KB

GoDoc

Anim

demo

Anim is an easy to use animation player package for Ebitengine v2

import "github.com/setanarut/anim"

Tutorial

Let's declare a global variable for the animation player

var animPlayer *anim.AnimationPlayer

Make new animation player from sprite atlas

runner

spriteSheet := anim.Atlas{
	Name:  "Default",
	Image: ebiten.NewImageFromImage(img),
}
animPlayer = anim.NewAnimationPlayer(spriteSheet)

Let's specify the coordinates of the animations for the player states. The figure shows the coordinates for "run" state.

diag

animPlayer.NewAnim("idle", 0, 0, 32, 32, 5, false, false, 5)
animPlayer.NewAnim("run", 0, 32, 32, 32, 8, false, false, 12)
animPlayer.NewAnim("jump", 0, 32*2, 32, 32, 4, false, false, 15)

Let's set the initial animation state.

animPlayer.SetAnim("idle)

Update animation player

func (g *Game) Update() error {
	animPlayer.Update()

Let's update the states according to the character's movement.

if ebiten.IsKeyPressed(ebiten.KeySpace) {
	animPlayer.SetAnim("jump")
} else if ebiten.IsKeyPressed(ebiten.KeyD) {
	animPlayer.SetAnim("run")
} else if ebiten.IsKeyPressed(ebiten.KeyA) {
	animPlayer.SetAnim("run")
	// FlipX
	DIO.GeoM.Scale(-1, 1)
	// Align to zero
	DIO.GeoM.Translate(float64(animPlayer.CurrentFrame.Bounds().Dx()), 0)
} else {
	animPlayer.SetAnim("idle")
}

Finally let's draw Animation player

func (g *Game) Draw(screen *ebiten.Image) {
	screen.DrawImage(animPlayer.CurrentFrame, DIO)

Examples

Simple demo

Run demo on your local machine

go run github.com/setanarut/anim/examples/demo@latest

Multiple sprite sheet example

Example of alternative sprite sheets with exactly the same coordinates.
Run atlases on your local machine;

go run github.com/setanarut/anim/examples/atlases@latest