Spritesheet 3000 for Unity

Custom pipeline plugin about how to make work together Adobe Photoshop's files with Unity Engine's sprites and sprite atlases.

Unity Plugin

The latest version can be installed via package manager using following git URL:
https://github.com/am1goo/unity-plugin-spritesheet-3000.git#0.4.30

Getting started

Adobe Photoshop CC Extension

• Install extentions via Unity Editor menu
  in top menu find and click Spritesheet 3000 -> Install extensions -> Adobe Photoshop CC

or

• Install extentions by yourself
  in top menu find and click Spritesheet 3000 -> Open extensions folder -> Adobe Photoshop CC

• Copy folder com.am1goo.photoshop.extension.spritesheet3000
  into C:\Program Files\Common Files\Adobe\CEP\extensions\ (for Windows x64)
  or
  into C:\Program Files (x86)\Common Files\Adobe\CEP\extensions\ (for Windows x86)

Format structure

Adobe Photoshop's extensions will create some files with ease-to-use structure:

• metafile starts with source psd filename (heart of this plugin, contains all required meta information about future animation clip - filter type, compression, ppu and etc.)
• bunch of animation frames as single sprites starts with metafile name (don't worry about that, these files will be skipped and don't used in runtime-mode at all, needed only in editor-mode purposes)
• atlas texture as result of importing process

folder|-
      |- {clipname}.txt
      |- {clipname}_01.png
      |- {clipname}_02.png
      |- {clipname}_03.png
      |- {clipname}_04.png
      |- ...
      |- {clipname}_xx.png
      |- {clipname}.asset
      |- {clipname}_atlas.asset

How to use

• Open extension via Adoby Photoshop CC
  Window -> Extensions -> Spritesheet 3000 Exporter

• Export all frames as single files and generate metadata
  Set all options and press button Export..

• Import frames via single metedata file
  Open Unity Editor, select single metafile in Project window, click Right Mouse Button and select Pack from file

or

• Import bunch of frames via folder
  Open Unity Editor, select whole folder in Project window, click Right Mouse Button and select Pack from folder

• Use packed frames in your game
  Put component SpriteAnimator3000 on any game object
  Run any animations via code:

using Spritesheet3000;
using UnityEngine;

public class Example : MonoBehaviour
{
    [SerializeField]
    private SpriteAnimationClip3000 _clip;
    [SerializeField]
    private SpriteAnimator3000 _anim;

    private void Awake()
    {
        _anim.Play(_clip);
    }
}

What's next?

• Add ability to trimming all transparent pixels from frames
• Export all frames to UnityEngine.U2D.SpriteAtlas file with .asset extension

Tested in

• Unity 2019.4.x
• Unity 2020.3.x
• Unity 2022.3.x

Using in

• Sin Slayers: Reign of The 8th - RPG with roguelike elements set in a dark fantasy world, where your choices determine how challenging the fights and enemies will be.
• Sin Slayers: Meat & Greed - A chill idle-mining sim that lives on your desktop. Dig rocks, collect gems, buy upgrades, feed your greed, and uncover shiny surprises while you do other things.

Contribute

Contribution in any form is very welcome. Bugs, feature requests or feedback can be reported in form of Issues.