https://github.com/Whitebrim/AnimatedSprite

Sprite class extension with imagetable animation and finite state machine support for @Playdate
https://github.com/Whitebrim/AnimatedSprite

animation library lua playdate sprites

Last synced: about 2 months ago
JSON representation

Sprite class extension with imagetable animation and finite state machine support for @Playdate

• Host: GitHub
• URL: https://github.com/Whitebrim/AnimatedSprite
• Owner: Whitebrim
• License: mit
• Created: 2021-10-12T22:10:17.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-05-15T02:21:57.000Z (4 months ago)
• Last Synced: 2024-05-15T20:13:49.875Z (4 months ago)
• Topics: animation, library, lua, playdate, sprites
• Language: Lua
• Homepage:
• Size: 188 KB
• Stars: 121
• Watchers: 5
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-playdate - AnimatedSprite - A lua-based library for animating sprites. Containing finite state machine, json configuration and plugNplay behaviour. (Game Development / Programming Frameworks & Languages)

README

        

# AnimatedSprite

[![Badge License]][License] [![Toybox Compatible](https://img.shields.io/badge/toybox.py-compatible-brightgreen?style=for-the-badge)](https://toyboxpy.io) [![Latest Version](https://img.shields.io/github/v/tag/Whitebrim/AnimatedSprite?style=for-the-badge)](https://github.com/Whitebrim/AnimatedSprite/tags)

Animated sprites library for the **[PlayDate]**.












[![Button Installation]][Install]   

[![Button Documentation]][Wiki]   

[![Button Performance]][Performance]









## Features

*How the sprites class has been extended:*

- **Sprite animations**

- **Finite State Machine**

- **JSON Configuration**







## Showcase

*A small example how you could use it:*

```lua

import 'AnimatedSprite.lua'

-- Loading imagetable from the disk

imagetable = playdate.graphics.imagetable.new('path')

-- Creating an AnimatedSprite instance

sprite = AnimatedSprite.new(imagetable)

-- Adding custom a animation state (Optional)

sprite:addState('idle',1,5,{ tickStep = 2 })

-- Playing the animation

sprite:playAnimation()

```







## Contacts

[![Button Telegram]][Telegram]   

[![Button Discord]][Discord]   

[![Button Mail]][Mail]




[Telegram]: https://tg.brim.su

[Playdate]: https://play.date/

[Discord]: https://discordapp.com/users/241961053578199040

[Wiki]: https://github.com/Whitebrim/AnimatedSprite/wiki

[Mail]: mailto:[email protected]

[Performance]: Documentation/Performance.md

[Install]: Documentation/Installation.md

[License]: LICENSE

[Badge License]: https://img.shields.io/badge/License-MIT-ac8b11.svg?style=for-the-badge&labelColor=yellow

[Button Documentation]: https://img.shields.io/badge/Documentation-0099E5?style=for-the-badge&logoColor=white&logo=GitBook

[Button Installation]: https://img.shields.io/badge/Installation-EF2D5E?style=for-the-badge&logoColor=white&logo=DocuSign

[Button Performance]: https://img.shields.io/badge/Performance-428813?style=for-the-badge&logoColor=white&logo=GoogleAnalytics

[Button Telegram]: https://img.shields.io/badge/Telegram-26A5E4?style=for-the-badge&logoColor=white&logo=Telegram

[Button Discord]: https://img.shields.io/badge/%40brim__-5865F3?style=for-the-badge&logoColor=white&logo=Discord

[Button Mail]: https://img.shields.io/badge/Email-EA4335?style=for-the-badge&logoColor=white&logo=Gmail