cl-aseprite

* cl-aseprite
[[https://gitlab.com/lockie/cl-aseprite/-/commits/develop][https://img.shields.io/gitlab/last-commit/lockie/cl-aseprite?ref=develop&style=flat&extension=.png]] [[https://gitlab.com/lockie/cl-aseprite/-/tags][https://img.shields.io/gitlab/v/tag/lockie/cl-aseprite?label=version&style=flat&extension=.png]] [[https://gitlab.com/lockie/cl-aseprite/-/blob/main/LICENSE][https://img.shields.io/gitlab/license/lockie/cl-aseprite?color=blue&style=flat&extension=.png]] [[https://functional.cafe/@awkravchuk][https://img.shields.io/mastodon/follow/109994839335624904?color=858AFA&domain=https%3A%2F%2Ffunctional.cafe&label=follow%20on%20mastodon&logo=mastodon&style=flat&extension=.png]]

*NOTE: this software is of alpha quiality, and the API is subject to change.*

~cl-aseprite~ is a high-performance Common Lisp library for parsing ~.aseprite~ files created with [[https://aseprite.org][Aseprite]] and [[https://libresprite.github.io][LibreSprite]] programs into meaningful Lisp structures.

Aseprite is a proprietary image editor designed for pixel art drawing and animation. It was used in the development of several notable games such as Celeste, Loop Hero, and many others (source: [[https://en.wikipedia.org/wiki/Aseprite][Wikipedia]]).

LibreSprite is a free and open source fork of Aseprite created after its license changed from GPLv2 to proprietary in 2016.

See the [[https://lockie.gitlab.io/cl-aseprite][documentation page]] for more details.

** Features
Provides complete information on all [[https://aseprite.org/docs/layers][layers]], [[https://aseprite.org/docs/new-frame][frames]], [[https://aseprite.org/docs/cel][cels]] and [[https://aseprite.org/docs/tags][tags]] saved within the ~.aseprite~ file, as well as [[https://aseprite.org/docs/sprite][sprite's metadata]].

*** Things NOT (yet) fully supported
- non-text userdata properties (only reachable via [[https://aseprite.org/api/properties][scripting]] anyways)
- [[https://aseprite.org/docs/tilemap][tilemaps and tilesets]]
- external file references (palettes, tilesets or extensions)
- [[https://aseprite.org/docs/slices][9-slices]]

** Installation
For now, you'll have to install [[http://dist.luckylambda.technology/releases/lucky-lambda/][LuckyLambda]] Quicklisp distribution (assuming you have [[https://quicklisp.org][Quicklisp]] installed) by executing the following in your Lisp :
#+begin_src lisp
  (ql-dist:install-dist "http://dist.luckylambda.technology/releases/lucky-lambda.txt")
#+end_src

Alternatively, just clone this repository to your [[http://blog.quicklisp.org/2018/01/the-quicklisp-local-projects-mechanism.html][Quicklisp's local-projects]] directory and execute ~(ql:quickload :cl-aseprite)~ in your Lisp.

Currently tested to work with SBCL on Linux, MacOS & Windows. Your Lisp implementation should [[https://github.com/phoe/trivial-package-local-nicknames#supported-implementations][support package-local nicknames]] for this library to work.

*** Dependencies
Installed automatically by Quicklisp, but are worth mentioning.

- [[https://github.com/j3pic/lisp-binary][lisp-binary]]
- [[https://github.com/sharplispers/chipz][chipz]]
- [[https://github.com/m2ym/trivial-types][trivial-types]]
- [[https://gitlab.common-lisp.net/alexandria/alexandria][alexandria]]
- [[https://github.com/sharplispers/let-plus][let-plus]]

** Usage
#+begin_src lisp
  (ql:quickload :cl-aseprite)
  (describe
   (time
    (ase:load-sprite "your-sprite-file.aseprite")))
#+end_src

** Roadmap
AKA TODO list
- +documentation+
- +tests+
- cover missing features

** Contributing
Merge requests are welcome, just please submit them against the =develop= branch. For major changes, please [[https://gitlab.com/lockie/cl-aseprite/-/issues/new][open an issue]] first to discuss what you would like to change.

** Copyright
Copyright (C) 2024 Andrew Kravchuk (awkravchuk@gmail.com)

** License
[[https://choosealicense.com/licenses/gpl-3.0][GPLv3]] (since [[https://github.com/j3pic/lisp-binary][lisp-binary]], on which this library is based, is licensed under GPLv3 anyway)


alexandria

chipz

cl-aseprite

Upstream URL

Author

License

cl-aseprite

Version:

License:

Authors:

Dependencies:

cl-aseprite/tests

License:

Authors:

Dependencies:

Dependencies (6)

Dependents (0)