add_reference_layer
Add a dimmed, locked reference layer to an Aseprite sprite so you can trace over guide art while keeping it out of exports.
Instructions
Add a dimmed, locked layer holding a reference image to trace over.
Args:
image_file: The reference image/sprite.
layer_name: Name for the new layer (default "reference").
opacity: Layer opacity (0-255); dim it so your art stands out.
scale_to_fit: Resize the reference to the canvas size (smooth).
x, y: Placement when not scaling to fit.
frame: Which existing frame to place the reference on (1-based). An
out-of-range frame is rejected with the sprite's valid range.
Exclude this layer from exports with ignore_layer="<layer_name>".
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | No | Default: 0. | |
| y | No | Default: 0. | |
| frame | No | Default: 1. | |
| opacity | No | Default: 128. | |
| filename | Yes | ||
| image_file | Yes | ||
| layer_name | No | Default: "reference". | reference |
| scale_to_fit | No | Default: false. |