Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 3.25 KB

README.md

File metadata and controls

90 lines (61 loc) · 3.25 KB
Logo

Aseprite-Library

A lua library for making Aseprite scripts & extensions

Report Bug Request Feature
License
Aseprite
Lua

About The Project

This project was made to remove the hassle of having to constantly look for functions on the api page.
With that in mind, this lua library lets view functions and fields on your project itself.

Socials

Reddit thread: [Release] Two Aseprite Projects: Script Development Library & Feature-Rich Extension

Installation

  1. Download the Lua extension on the VSCode Marketplace

From here you have 2 choices:

  1. Download the library file and paste it into your project anywhere

OR (Better, because using this method will make you able to stay synced to this repository.)

  1. Add the Aseprite-Library repository as a submodule to your project by running the following command git submodule add https://github.com/RampantDespair/Aseprite-Library lib/Aseprite-Library

  2. Add the following to your .vscode\settings.json file (if it doesn't exist, just create it)

{
  "Lua.workspace.library": ["lib\\Aseprite-Library\\Aseprite-Library.lua"]
}
  1. Start writing your script :)

Example

If you want to see a real usage example, you can go check out my Aseprite-Extension.

Important

Do not import the library file into your actual script (dofile/require), because this library is to be used strictly in development, not in production.

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request.
You can also simply open an issue with the tag "enhancement".
Any contributions you make are greatly appreciated.

Acknowledgments