spritesheet-js v1.2.8
Spritesheet.js is command-line spritesheet (a.k.a. Texture Atlas) generator written in node.js.
Supported spritesheet formats
- Starling / Sparrow
- JSON (i.e. PIXI.js)
- Easel.js
- cocos2d (i.e. version 2.x)
- cocos2d-v3 (i.e. version 3.x)
- CSS (new!)
Usage
Command Line
$ spritesheet-js assets/*.png
Options:
$ spritesheet-js
Usage: spritesheet-js [options] <files>
Options:
-f, --format format of spritesheet (starling, sparrow, json, pixi.js, easel.js, cocos2d) [default: "json"]
-n, --name name of generated spritesheet [default: "spritesheet"]
-p, --path path to export directory [default: "."]
--fullpath include path in file name [default: false]
--prefix prefix for image paths (css format only) [default: ""]
--trim removes transparent whitespaces around images [default: false]
--square texture should be s square [default: false]
--powerOfTwo texture width and height should be power of two [default: false]
--validate check algorithm returned data [default: false]
--algorithm packing algorithm: growing-binpacking (default), binpacking (requires passing --width and --height options), vertical or horizontal [default: "growing-binpacking"]
--width width for binpacking [default: undefined]
--height height for binpacking [default: undefined]
--padding padding between images in spritesheet [default: 0]
--scale percentage scale [default: "100%"]
--fuzz percentage fuzz factor (usually value of 1% is a good choice) [default: ""]
Node.js
var spritesheet = require('spritesheet-js');
spritesheet('assets/*.png', {format: 'json'}, function (err) {
if (err) throw err;
console.log('spritesheet successfully generated');
});
Trimming / Cropping
Spritesheet.js can remove transparent whitespace around images. Thanks to that you can pack more assets into one spritesheet and it makes rendering a little bit faster.
NOTE: Some libraries such as Easel.js dont't support this feature.
Installation
- Install ImageMagick
npm install spritesheet-js -g
Test
mocha test
Thanks Przemysław Piekarski for logo design and assets in examples.
2 years ago
7 years ago
7 years ago
7 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago