Back to Node List

Aseprite Export

aseprite_export

Writes an Aseprite document to disk when save mode allows it.

Reviewed
Guide available
The node name and summary are available in English. Port, parameter, and article details are currently shown in Japanese.

Input Ports

NameTypeDescription
Aseprite
ase
AsepriteFile
Required
保存したい Aseprite document です。

Output Ports

NameTypeDescription
Aseprite
ase
AsepriteFile
そのまま流した Aseprite document です。

Parameters

NameTypeDefaultRangeDescription / Options
パス
path
FilePath

保存先の `.ase` / `.aseprite` パスです。

保存モード
save_mode
Enum
Disabled

どの条件で実際に保存するかを切り替えます。

  • 無効Disabled
    ファイルへ書き込みません。
  • 新規のみCreateIfMissing
    ファイルが無い時だけ保存します。
  • 上書きOverwrite
    既存ファイルも上書き保存します。

Overview

Saves an Aseprite document as an .aseprite file. This is the endpoint of the Aseprite workflow, writing processed or generated PixPipeline results back into a form that Aseprite can open.

Usage tips

  • The default is Disabled to prevent accidental saves. Switch to CreateIfMissing or Overwrite only when you intend to write the file.
  • There are two entry paths for writing back: use image_to_aseprite for a single image or spritesheet_to_aseprite for an animation, converting it to a document before this node.

Related nodes

  • aseprite_load — the loading side
  • image_to_aseprite / spritesheet_to_aseprite — create the document upstream
  • ase_layer_select — narrows the layers before saving

Save modes

  • Disabled
    • Does not save, serialize the document, or validate file contents.
  • CreateIfMissing
    • Saves only if the file does not exist yet.
  • Overwrite
    • Overwrites an existing file.
    • Skips an unnecessary write when the bytes are identical.

Read this first

  • This is a side-effect node.
  • It writes a real file during evaluation.
  • It starts in Disabled mode to prevent accidental saves.

Basic workflow

AsepriteLoad
  -> AseLayerSelect
  -> AsepriteExport

This loads an Aseprite file, retains only the required layers, and saves the result to another file.

Example: Write back a processed image

AsepriteLoad
  -> AseFrameSelect
  -> Outline
  -> ImageToAseprite
  -> AsepriteExport

This extracts and processes one frame, then saves the result as a flat Aseprite document.

Example: Write back a sprite sheet

FxBakeSpriteSheet
  -> SpriteSheetToAseprite
  -> AsepriteExport

This saves an animation built in PixPipeline as an Aseprite timeline.

When to use it

  • To write back an Aseprite-derived document after selecting layers or frames
  • To save an AsepriteFile created in the graph
  • To save a flat document produced by ImageToAseprite or SpriteSheetToAseprite

Example

  • path = hero_body_only.aseprite
  • save_mode = Overwrite

During evaluation, the document connected to ase is saved to that path.
When a save occurs, _saved = true.

Supported data and discarded data

  • The output file always uses RGBA color mode. Indexed information is not restored even if the input document originated in Indexed mode.
  • Normal and Group layers, frames, tags, and the palette are written. Cells containing only transparent pixels are omitted from the file.
  • Original cell x/y offsets, cell opacity, and linked-cel relationships are not restored because they are materialized into canvas images during loading.
  • Tilemap contents, slices, and user data are not exported.
  • Unknown blend modes fall back to normal.

Notes

  • An empty path does not save anything.
  • Omitting the extension appends .aseprite. When saving is enabled, any extension other than .ase or .aseprite is an explicit error; Aseprite bytes are never written under a misleading format extension.
  • Disabled does not validate either the extension or serialized contents.
  • v1 does not aim to round-trip every piece of Aseprite metadata perfectly.
  • Some fine-grained editor-specific settings may not be preserved.
  • This stage establishes the basic "load, select, and save" I/O workflow in PixPipeline.
Back to Node List
Aseprite Export — PixPipeline Node Reference