Manage sprites
sprite_manageManage sprites in a live Aseprite session: open, create, save, resize, close, and define slices for engine readback.
Instructions
Open, create, focus, resize, save and close sprites in the running Aseprite session. Ops: 'list' (open documents), 'new', 'open', 'activate', 'save', 'save_as', 'close', 'resize_canvas', 'set_properties', 'slice_create', 'slice_update', 'slice_delete'. Canvas resize keeps existing pixels — pass an anchor to say where they land. Slices name a rectangular region of the canvas for an engine to read back — a 9-patch panel's center, or a hotspot's pivot.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| op | Yes | ||
| name | No | Slice name. Required for 'slice_create'; identifies it for update/delete. | |
| path | No | File path for 'open' and 'save_as'. | |
| color | No | For slice ops: slice colour in the timeline, #rrggbb. | |
| force | No | Allow 'close' to discard unsaved changes. Ask the user before setting this. | |
| pivot | No | For slice ops. | |
| width | No | ||
| anchor | No | Where existing pixels sit after 'resize_canvas'. | center |
| bounds | No | Slice rectangle. Required for 'slice_create'. | |
| center | No | For slice ops: nine-slice centre region, relative to `bounds`. | |
| height | No | ||
| sprite | No | Which sprite: its id as '#7' (what every result reports back, and the only unambiguous form — two unsaved documents are both called 'Sprite'), its filename, or its display name. Omit to use the sprite Aseprite has focused. | |
| colorMode | No | For 'new'. Indexed keeps a sprite honest about its palette. | |
| pixelAspect | No | e.g. '1:1' or '1:2'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Stable id of the affected document; pass it back as '#<id>'. | |
| op | Yes | ||
| name | No | Slice name, for 'slice_delete'. | |
| path | No | ||
| slice | No | The affected slice, for 'slice_create'/'slice_update'. | |
| width | No | ||
| height | No | ||
| sprite | No | ||
| sprites | No |