Skip to main content
Glama

export_godot_spriteframes

Destructive

Export an Aseprite sprite to a Godot 4 SpriteFrames .tres resource with a packed PNG sheet, JSON metadata, and AtlasTexture animations per tag.

Instructions

Export a sprite as a Godot 4 SpriteFrames resource (.tres) + a packed sheet.

Produces three files: a packed PNG sprite sheet, its JSON frame/tag metadata, and a
``SpriteFrames`` .tres that references the sheet via ``AtlasTexture`` regions, one
Godot animation per Aseprite tag (or a single ``default`` animation if untagged), with
per-frame timing taken from Aseprite frame durations.

v1 emits ``SpriteFrames`` only (no pivot/origin/hitbox/9-slice). Aseprite tag direction
isn't represented (Godot animations only loop or not); ``default_loop`` is applied to all.

Args:
    output: Destination .tres path (workspace-relative).
    sheet_output: Sheet PNG path. Defaults to ``<output stem>.png`` beside the .tres.
    scale: Integer upscaling factor for the sheet.
    texture_res_path: The ``res://`` path of the sheet inside your Godot project (the
        AtlasTexture atlas). Defaults to ``res://<sheet filename>`` (same-folder import).
    default_loop: ``loop`` flag for every generated animation (default True).
    overwrite: Replace existing outputs (default False = no-clobber). All three targets
        are validated up front, so nothing is written if any already exists.

Returns a ``workflow_manifest.v1`` manifest (kind ``engine_preset``).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
scaleNoDefault: 1.
outputYes
filenameYes
overwriteNoDefault: false.
default_loopNoDefault: true.
sheet_outputNo
texture_res_pathNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed17 schema fields changedv0.10.0
    • addedInput schema / properties / default_loop / description
      Added value: +"Default: true."
    • removedInput schema / properties / default_loop / title
      Removed value: -"Default Loop"
    • removedInput schema / properties / filename / title
      Removed value: -"Filename"
    • removedInput schema / properties / output / title
      Removed value: -"Output"
    • addedInput schema / properties / overwrite / description
      Added value: +"Default: false."
    • removedInput schema / properties / overwrite / title
      Removed value: -"Overwrite"
    • addedInput schema / properties / scale / description
      Added value: +"Default: 1."
    • removedInput schema / properties / scale / title
      Removed value: -"Scale"
    • removedInput schema / properties / sheet_output / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • removedInput schema / properties / sheet_output / default
      Removed value: -null
    • removedInput schema / properties / sheet_output / title
      Removed value: -"Sheet Output"
    • addedInput schema / properties / sheet_output / type
      Added value: +"string"
    • removedInput schema / properties / texture_res_path / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • removedInput schema / properties / texture_res_path / default
      Removed value: -null
    • removedInput schema / properties / texture_res_path / title
      Removed value: -"Texture Res Path"
    • addedInput schema / properties / texture_res_path / type
      Added value: +"string"
    • removedInput schema / title
      Removed value: -"export_godot_spriteframesArguments"
  2. First observedv0.7.0

TDQS

A4.3/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations declare destructiveHint=true, but the description adds substantial context beyond them: no-clobber default, up-front validation of all three targets ('nothing is written if any already exists'), and v1 limitations (no pivot/origin/hitbox/9-slice, tag direction not represented, default_loop applied to all). This materially mitigates and elaborates the destructive profile.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose and outputs are front-loaded, followed by an Args block and a concise return line; every sentence carries information. It is somewhat long, but no sentence is filler given the mutation and v1 caveats it must convey.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no output schema, it discloses the return type (workflow_manifest.v1, kind engine_preset), side effects, no-clobber semantics, and scope limitations. The only meaningful omission is the required filename parameter, which is undocumented in both description and schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 43% (most params carry just a 'Default:' string), so the description compensates well: it explains output, sheet_output's derivation from output stem, scale's meaning as upscaling factor, texture_res_path's res:// role and default, plus default_loop and overwrite semantics. The required 'filename' param remains unexplained, so it falls short of full compensation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Export a sprite as a Godot 4 SpriteFrames resource (.tres) + packed sheet') and enumerates the three concrete artifacts produced. This distinguishes it from siblings like export_spritesheet, export_gif, and export_game_asset_bundle without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied by the Godot-4 engine target and the v1 scope note, but the description never names an alternative export tool or states when to prefer this over export_spritesheet/export_game_asset_bundle. No explicit when/when-not routing is provided, leaving selection to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools