This repository developed out of the Medium article, "How To Script Aseprite Tools in Lua". Short demonstrations for some the scripts here can be found in this Youtube playlist.
As of Wednesday, November 20, 2024, this repository has a Beta branch. The Beta branch corresponds with Aseprite version 1.3.11-beta1. You will need the beta version of Aseprite to use scripts in that branch. The primary difference between the two branches is how scripts in the dialogs/shape folder work. Primary development of this repository will take place in the Beta branch. The main branch will focus on bug fixes.
To install, click on the green Code
button above. Select Download ZIP
from the pop-up menu. Unzip the file after it has finished downloading. In Aseprite, go to File > Scripts > Open Scripts Folder
. Copy commands
, dialogs
and support
folders from the unzipped download into the folder that Aseprite has opened. Return to Aseprite, go to File > Scripts > Rescan Scripts Folder
.
There is a known issue when Aseprite's script folder is on a file path that includes characters such as 'é' (e acute) or 'ö' (o umlaut).
Aseprite version 1.3.10 is the minimum supported version to run these scripts.
To use, go to File > Scripts
and choose from entries in the dialogs
or commands
folder.
Scripts can be assigned shortcuts in Edit > Keyboard Shortcuts
. Dialog buttons can be called by holding down the Alt
key and pressing the underlined letter of the button's label. For example, Alt C
will close dialogs, per the 'C' in "CANCEL".
Most scripts dealing with color assume standard RGB is the working color profile. The window profile is set under Edit > Preferences > Color
. The sprite profile is set under Sprite > Properties
.
For more resources, see
- Aseprite Type Definition
- Aseprite CPP source that receives Lua inputs
- Aseprite Scripting API
- Lua Documentation
- Aseprite General Documentation
- Aseprite Forum
This repo includes
-
Export Tile Maps and Sets to Tiled.
-
Color curves. (Test image source.)
-
A conic gradient.
-
A Floyd-Steinberg filter (Test model source.)
-
A text insertion dialog.
-
Interlaced layers. (Test image source.)
-
LCh color picker.
-
A linear gradient.
-
Gradient map. (Test image source.)
-
Custom New Sprite
-
Normal color picker.
-
Normal from height.
-
Outline Gradient.
-
Palette Manifest.
-
Palette To Cel Assignment.
-
A radial gradient.
-
RGB channel separation.
-
Basic cel transformation.
Appearances may vary as features are added to or removed from underlying scripts.