# spritesheet-splitter-cli

> CLI tools for export sprites from sprite sheet.

Latest version **1.0.12** (published 2020-06-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install spritesheet-splitter-cli
pnpm add spritesheet-splitter-cli
yarn add spritesheet-splitter-cli
bun add spritesheet-splitter-cli
```

Provides the command `spritesheet-splitter`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.12 |
| Published | 2020-06-06 |
| First published | 2020-05-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 138.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Vadim Postnikov |
| Maintainers | rocket-ua |
| Keywords | sprite, spritesheet, sprite sheet, splitter |

## Links

- npm: https://www.npmjs.com/package/spritesheet-splitter-cli
- Repository: https://github.com/rocket-ua/spritesheet-splitter-cli
- Homepage: https://github.com/rocket-ua/spritesheet-splitter-cli#readme
- Issues: https://github.com/rocket-ua/spritesheet-splitter-cli/issues
- npm.io page: https://npm.io/package/spritesheet-splitter-cli

## Dependencies (5)

- [xhr2](https://npm.io/package/xhr2.md) ^0.2.0
- [yargs](https://npm.io/package/yargs.md) ^15.3.1
- [canvas](https://npm.io/package/canvas.md) ^2.5.0
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.23
- [filereader](https://npm.io/package/filereader.md) ^0.10.3

## Recent versions

- 1.0.12 (latest) — 2020-06-06
- 1.0.11 — 2020-06-04
- 1.0.10 — 2020-06-03
- 1.0.9 — 2020-06-03
- 1.0.8 — 2020-06-02
- 1.0.7 — 2020-05-31
- 1.0.6 — 2020-05-31
- 1.0.5 — 2020-05-31
- 1.0.4 — 2020-05-31
- 1.0.3 — 2020-05-30
- 1.0.2 — 2020-05-30
- 1.0.1 — 2020-05-30

## README

# Sprite sheet splitter
CLI tools for export sprites from sprite sheet.  
You need to have data file and image for sprite sheet witch will be exported.  
___
## Features
Supported local files and can download files use http or https.  
Supported data files formats and sprite sheets for engines:
<ul>  
<li>JSON (Array)</li>
<li>JSON (Hash)</li>
<li>Spine atlas</li>
<li>Godot 3 Sprite Sheet</li>
<li>Godot 3 Tile Set</li>
<li>LayaAir2.0</li>
<li>libGDX</li>
<li>MelonJS</li>
<li>Panda 2</li>
<li>Phaser 2</li>
<li>Phaser 3</li>
<li>Spark AR Studio</li>
<li>Unity JSON data</li>
<li>UnrealEngine</li>
<li>V-Ray</li>
</ul>  
  
#### More data formats and file types coming soon.  

## Parameters
<ul>  
<li>--data - path to data file of sprite sheet</li>   
<li>--out - path to folder where will be saved exported sprites</li>
</ul>  

## How to use
Use sprite sheet local files for split  
```
spritesheet-splitter --data ./spritesheet.json --out ./splitted/
```
Use sprite sheet files downloaded using http or https for split 
```
spritesheet-splitter --data http://testSite.com/spritesheet.json --out ./splitted/
```
___  
### Web version  
You can try to use web version [spritesheet-splitter](https://rocket-ua.github.io/spritesheet-splitter/)  
Readme how to use on [github](https://github.com/rocket-ua/spritesheet-splitter#readme)  
  
### Contacts  
Telegram [@rocket_ua](https://t.me/rocket_ua)

---
_Source: https://npm.io/package/spritesheet-splitter-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._