kjarrio / SpriteExtractor

Spritesheet Image Extractor

Sprite Extractor

Sprite Extractor is a Java Library that exports images from multiple formats of sprite sheets.

It currently supports these formats:

• 2D Toolkit
• Amethyst
• AppGameKit
• Blacksmith 2D
• BHive
• CAAT
• CEGUI / OGRE
• EaselJS / CreateJS
• Egret Engine
• JSON (Hash)
• JSON (Array)
• Kivy
• LayaAir 2.0
• Mapbox
• MelonJS
• Molecule
• Unity® - Texture2D

It will detect the format automatically and extract to a given output folder.

Installation

Using Maven:

<dependency>
    <groupId>io.github.kjarrio</groupId>
    <artifactId>SpriteExtractor</artifactId>
    <version>1.1</version>
</dependency>

Usage

import io.github.kjarrio.extractor.SpriteExtractor;

File spriteSheet = new File("spritesheet.json");
File outputDir = new File("/output/dir");

SpriteExtractor.extract(spriteSheet, outputDir);

Roadmap

The goal is to support as many formats as possible, such as:

• BatteryTech SDK (Work in Progress)
• cocos2d and cocos2d-x
• CSS Simple & (Responsive/Retina)
• Gideros
• Godot 3
• Kwik (image sheet)
• LESS (css)
• LibGDX
• libRocket RCSS
• Moai
• MonoGame
• Orx
• Panda 2
• Phaser (JSONArray / JSONHash)
• Phaser 3
• PixiJS
• PopcornFX
• SASS Mixins (css)
• Shiva3D (+ JPSprite extension)
• Slick2d
• Solar3D
• SPark AR Studio (Facebook)
• Sparrow / Starling
• Spine
• SpriteKit (Swift)
• Spriter
• SpriteStudio
• TreSensa
• UIKit (Plist)
• Unity® - JSON data (txt)
• UnrealEngine - Paper2d
• V-Play
• WaveEngine (xml)
• x2d engine
• XAML Resource Dictionary (NoesisGUI)
• XML (generic)

Future goals may also include:

• Bitmap Fonts of all types
• More image formats, it currently only support PNG.
• Converting between different types of formats of sprite sheets.
• Removing, replacing and adding images to existing sprite sheets.
• Creating new sprite sheets from scratch.

Contributing

Pull requests are welcome and please make sure to update tests as appropriate.

Authors

Kjartan Olason (kjarrio)

License

MIT