# multi-sprite-creator

> Tool for creating sprites with width and height limitation

Latest version **2.0.0** (published 2021-11-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install multi-sprite-creator
pnpm add multi-sprite-creator
yarn add multi-sprite-creator
bun add multi-sprite-creator
```

## 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 | 2.0.0 |
| Published | 2021-11-17 |
| First published | 2021-11-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 15.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Anton Pavlov |
| Maintainers | aapavlov1994 |
| Keywords | sprite, multi, maxsize, width, limit, creator |

## Links

- npm: https://www.npmjs.com/package/multi-sprite-creator
- Repository: https://github.com/aapavlov1994/multi-sprite-creator
- Homepage: https://github.com/aapavlov1994/multi-sprite-creator#readme
- Issues: https://github.com/aapavlov1994/multi-sprite-creator/issues
- npm.io page: https://npm.io/package/multi-sprite-creator

## Dependencies (5)

- [jimp](https://npm.io/package/jimp.md) ^0.16.1
- [vinyl](https://npm.io/package/vinyl.md) ^2.2.1
- [through2](https://npm.io/package/through2.md) ^4.0.2
- [pixelsmith](https://npm.io/package/pixelsmith.md) ^2.5.0
- [concat-stream](https://npm.io/package/concat-stream.md) ^2.0.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2021-11-17
- 1.0.0 — 2021-11-15

## README

# multi-sprite-creator

Tool for creating sprites with width and height limitation

### Usage

`npm i multi-sprite-creator`

```javascript
const { create, calculate } = require('multi-sprite-creator');

const options = {
  scale: 0.7, // scale of assets
  padding: 1, // padding between images
  maxHeight: 500, // sprite height limit
  maxWidth: 500, // sprite width limit
};

// use array of paths
const imagesCollection = [
  'pathTo/img1.png',
  'pathTo/img2.png',
];
// or array of node buffers
const imagesCollection = [
  Buffer1,
  Buffer2,
];
// or collection of paths
const imagesCollection = {
  img1Name: 'pathTo/img1.png',
  img2Name: 'pathTo/img2.png',
};
// or collection of node buffers
const imagesCollection = {
  img1Name: Buffer1,
  img2Name: Buffer2,
};

// use this function if you want caclulate and create spritesheets
create(imagesCollection, options)
  .then((sprites) => {
    console.log(sprites); // sprites array
    sprites.forEach((sprite) => {
      console.log(sprite.width); // result width (<= maxWidth)
      console.log(sprite.height); // result height (<= maxHeight)
      console.log(sprite.map); // images coordinates, sizes, keys or imageNames
      console.log(sprite.image); // buffer ready to write
    });
  });

// use this function if you want only caclulate sprites maps (atlases)
calculate(imagesCollection, options)
  .then((atlases) => {
    console.log(atlases); // atlases array
    atlases.forEach((atlas) => {
      console.log(atlas.width); // result width (<= maxWidth)
      console.log(atlas.height); // result height (<= maxHeight)
      console.log(atlas.files); // images coordinates, sizes,  keys or imageNames, buffers
    });
  });
```

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