Back to Node List

Sprite Sheet Import

sprite_sheet_import

Analyzes an external sheet, previews the proposed grid, then repacks confirmed cells without margins or spacing.

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

Output Ports

NameTypeDescription
スプライトシート
spritesheet
SpriteSheet
確定後に余白と間隔を除いて再配置した標準スプライトシートです
元画像
source
Image
選択した元画像です
分割線プレビュー
overlay
Image
現在の候補または手動設定のセル境界を水色で重ねた確認画像です
信頼度
confidence
Float
自動検出候補の信頼度です。0.75以上を目安にし、それ未満は分割線をよく確認します
候補JSON
candidate_json
Text
検出した列・行・セル寸法・余白・間隔です
警告コード
warnings
Text
未確定、低信頼度、空セル、未使用領域を示す安定コードです
取り込みレポートJSON
report_json
Text
取り込みアシスタント向けの構造化診断です

Parameters

NameTypeDefaultRangeDescription / Options
シート画像
path
FilePath

分割を調べる外部スプライトシートを選びます。元ファイルは変更しません

分割設定
layout_mode
Enum
Detected

水色の分割線がフレームと合わないときだけ手動修正へ切り替えます

  • 自動候補Detected
    透明な区切りから検出した候補を使います
  • 手動修正Manual
    分割線が違うときに列・行・寸法・余白・間隔を直します
透明判定
alpha_threshold
Float
0.010–1 / step 0.01

この値以下の透明度を区切りとみなします。通常は0.01、縁に薄いノイズがある素材は0.05〜0.15が目安です

この分割で確定
confirmed
Bool
false

分割線を確認してから有効にします。未確定中はスプライトシート出力が安全な仮画像のままです

FPS
fps
Int
121–60

確定シートへ保存する再生速度です。粗めのドット絵は8〜12、滑らかな動きは24が目安です

列数
columns
Int
10–128

横に並ぶフレーム数です

行数
rows
Int
10–128

縦に並ぶフレーム数です

フレーム幅
frame_width
Int
10–4096

余白を含まない1フレームの幅です

フレーム高さ
frame_height
Int
10–4096

余白を含まない1フレームの高さです

左余白
margin_x
Int
00–4096

最初のセルまでの左余白です

上余白
margin_y
Int
00–4096

最初のセルまでの上余白です

横間隔
spacing_x
Int
00–4096

セル同士の横方向の間隔です

縦間隔
spacing_y
Int
00–4096

セル同士の縦方向の間隔です

Overview

Safely converts an external sprite sheet with margins or spacing into PixPipeline's standard SpriteSheet. It shows cyan split lines and confidence before confirmation, preventing a bad automatic split from silently reaching downstream nodes.

Usage tips

  1. Select the sheet image and preview overlay.
  2. Even at confidence 0.75 or above, verify that every frame fits inside the cyan boxes.
  3. If the split is wrong, switch to Manual and adjust columns, rows, frame dimensions, top-left margin, and spacing.
  4. Review SPRITESHEET_EMPTY_CELL and SPRITESHEET_UNUSED_PIXELS. When intentional, enable Confirm This Split.

After confirmation, margins and spacing are removed and frames are repacked into the existing SpriteSheet schema. Margin and spacing are not added to the stored format.

Common mistakes

  • Fully transparent rows or columns inside a character can make automatic detection split too finely. Use Manual when confidence is low.
  • If translucent edge noise hides separators, raise Transparency Threshold gradually from about 0.05 to 0.15. Too high a value can erase faint effects, so recheck the overlay.
  • Before confirmation, spritesheet is a safe 1×1 placeholder. If downstream appears empty, confirm the reviewed split.

Related nodes

  • sprite_sheet_to_frames — expand the confirmed sheet into a frame list
  • sprite_sheet_playback — preview the confirmed animation
  • sprite_sheet_info — attach layout metadata to an already margin-free sheet
  • image_sequence_import — use when every frame is supplied as a separate file
Back to Node List
Sprite Sheet Import — PixPipeline Node Reference