Skip to content
Basic playback support for the 2D animation tool Spriter within the game framework love2d.
Lua Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
spriter.love
.gitignore
README.md
scml2lua.py

README.md

spriter-love2d

Basic playback support for the 2D animation tool Spriter within the game framework love2d.

Quick start

Drag the project folder spriter.love onto the love executable to launch the spriter demo. Use the arrow keys to move the demo character about.

You may download the latest love executable for your platform from the love2d website: http://love2d.org/

Importing data

In order to avoid parsing XML files during runtime, you need to convert Spriter SCML files to lua data files ahead of time. You should use the included python script scml2lua.py to convert files from Spriter to be read with spriter-love2d.

You may download the latest free beta version of Spriter from Brashmonkey's website: http://brashmonkey.com/spriter.htm

The following terminal command will convert the BetaFormatHero included with the Spriter beta to a lua data file:

python scml2lua.py BetaFormatHero.SCML >> BetaFormatHero.SCML.lua

Basic usage

Include the file spriter.lua, your Spriter image folders and the converted SCML file in your own love2d project. Here is an outline of how to load and draw a frame of Spriter animation.

local data= Spriter.new ('BetaFormatHero.lua')
local anim= data.getAnim ('idle_healthy')
local i= anim.getFrameIndex (tsec * 100)
local frame= data.getFrame(anim.getFrameName (i))
frame.draw(x, y, r, sx, sy)

See the project file main.lua for an example basic playback for Spriter.

Feedback

Contact me at @mariocaprino for comments and feedback!

You can’t perform that action at this time.