aseprite / docs

Aseprite documentation

Aseprite

Introduction

Aseprite is a program to create animated sprites. Its main features are:

• Sprites are composed of layers & frames as separated concepts.
• Support for color profiles and different color modes: RGBA, Indexed (palettes up to 256 colors), Grayscale.
• Animation facilities, with real-time preview and onion skinning.
• Export/import animations to/from sprite sheets, GIF files, or sequence of PNG files (and FLC, FLI, JPG, BMP, PCX, TGA).
• Multiple editors support.
• Layer groups for organizing your work, and reference layers for rotoscoping.
• Pixel-art specific tools like Pixel Perfect freehand mode, Shading ink, Custom Brushes, Outlines, Wide Pixels, etc.
• Other special drawing tools like Pressure sensitivity, Symmetry Tool, Stroke and Fill selection, Gradients.
• Tiled mode useful to draw patterns and textures.
• Transform multiple frames/layers at the same time.
• Lua scripting capabilities.
• CLI - Command Line Interface to automatize tasks.
• Quick Reference / Cheat Sheet keyboard shortcuts (customizable keys and mouse wheel).
• Reopen closed files and recover data in case of crash.
• Undo/Redo for every operation and support for non-linear undo.
• More features & tips

Issues

There is a list of Known Issues (things to be fixed or that aren't yet implemented).

If you found a bug or have a new idea/feature for the program, you can report them.

Support

You can ask for help in:

• Aseprite Community
• Aseprite Discord Server
• Official support: [email protected]
• Social networks and community-driven places: Twitter, Facebook, YouTube, Instagram.

Authors

Aseprite is being developed by Igara Studio:

• David Capello
• Gaspar Capello
• Martín Capello

Credits

The default Aseprite theme was introduced in v0.8, created by:

• Ilija Melentijevic

A modified dark version of this theme introduced in v1.3-beta1 was created by:

• Nicolas Desilets
• David Capello

Aseprite includes color palettes created by:

• Richard "DawnBringer" Fhager, 16 colors, 32 colors.
• Arne Niklas Jansson, 16 colors, 32 colors.
• ENDESGA Studios, EDG16 and EDG32, and other palettes.
• Hyohnoo Games, mail24 palette.
• Davit Masia, matriax8c palette.
• Javier Guerrero, nyx8 palette.
• Adigun A. Polack, AAP-64, AAP-Splendor128, SimpleJPC-16, and AAP-Micro12 palette.
• PineTreePizza, Rosy-42 palette.

It tries to replicate some pixel-art algorithms:

• RotSprite by Xenowhirl.
• Pixel perfect drawing algorithm by Sébastien Bénard and Carduus.

Thanks to third-party open source projects, to contributors, and all the people who have contributed ideas, patches, bugs report, feature requests, donations, and help us to develop Aseprite.

License

This program is distributed under three different licenses:

1. Source code and official releases/binaries are distributed under our End-User License Agreement for Aseprite (EULA). Please check that there are modules/libraries in the source code that are distributed under the MIT license (e.g. laf, clip, undo, observable, ui, etc.).
2. You can request a special educational license in case you are a teacher in an educational institution and want to use Aseprite in your classroom (in-situ).
3. Steam releases are distributed under the terms of the Steam Subscriber Agreement.

You can get more information about Aseprite license in the FAQ.

docs's Issues

PDF version of docs

Some users asked for a PDF version of the docs, we could try to convert markdown files to pdf using pandoc.

`image:flip()` is not documented under Image

The API overview on the website doesn't mention the Image:flip() function, nor the expected arguments on the Image page. https://www.aseprite.org/api/image#image

The only reason I found out it existed is from the patchnotes for Aseprite v1.3-rc4. FlipType is documented, although it seems like a floating page, that isn't linked from anywhere unless you search for it.

At first I thought it might not be documented yet due to being experimental still, but as far as I know 1.3 is out!

I haven't checked whether the other recently added functions are documented on the API website

Inconsistencies betweeen table of content and available pages.

1. go to https://www.aseprite.org/docs/
2. see this
   

expected: Table of content on the left is the same as main content.

A mistype

While looking at the docs FAQ page, I noticed that at the bottom of the page, where it says "It's a little "tribute" to what we think it's the greatest game of all times: Super Mario World. Specifically it references one of the few animated blocks of this game: the rotating block.". The bolded words, 'think it's' I think should be changed to 'think is'. Otherwise it would be like saying: "It's a little "tribute" to what we think it is the greatest game of all times: Super Mario World." Thanks for reading this, I'll continue reading the docs and post issues here! <3 (Also not sure about this one but in the same place, "times" I think should be time) If you guys think that the docs are fine the way they are, please tell me and I'll stop, thanks again!

Japanese translation

Hi! I translated almost whole docs into Japanese except cli, tutorial, extension details.

You can see here:
GitHub Pages: https://chiepomme.github.io/aseprite-docs-jp/
Repo: https://github.com/chiepomme/aseprite-docs-jp

I have some questions.

1. Can I continue publishing this Japanese version?
   • I couldn't find any license of the documents.
2. Is there any official way to contribute with this translation?
   • I found languages extension repo (https://github.com/aseprite/languages), but I couldn't find repos about document translation.

Expand the `Tools Bar` page

Especially in regards to selection tools and linking them in the Transformations pages (Rotate etc.).

Add documentation about selection by Color Range

`Palette.getColor()` requires `(Palette, Index)` arguments, not `(index)`

It's incorrectly stated in the documentation here: https://www.aseprite.org/api/palette#palettegetcolor

I presume it's a recent change, due to all the mentions about Palettes becoming frame based in the future.

When using

local mypalette = app.sprite.palettes[1]
app.fgColor = mypalette.getColor(1)

I got the error that it expected a PaletteObject, not an index on the first argument.

However, this did work:

local mypalette = app.sprite.palettes[1]
app.fgColor = mypalette.getColor(mypalette, 1)

Document Dialog's :tab() and :endtabs() usage

Add documentation about how to use the tab() and endtabs() functions to add Tabs like widgets to Dialogs using the Lua API.
Related to aseprite/aseprite#3998