PHPackages                             sabi/spritesheet-generator - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. sabi/spritesheet-generator

ActiveLibrary

sabi/spritesheet-generator
==========================

Simple php library that combine seperated images(png) to one spritesheet image and replace background color with transparent and generate css

00PHP

Since Jun 5Pushed 2y ago1 watchersCompare

[ Source](https://github.com/sabertahmasbi/spritesheet-generator)[ Packagist](https://packagist.org/packages/sabi/spritesheet-generator)[ RSS](/packages/sabi-spritesheet-generator/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

PHP Spritesheet generator
=========================

[](#php-spritesheet-generator)

Simple php library that combine seperated images(png) to one spritesheet image and replace background color with transparent and generate css

Installation
------------

[](#installation)

Install with composer

```
  composer require sabi/spritesheet-generator
```

Tech Stack
----------

[](#tech-stack)

**Server:** PHP

Methods
-------

[](#methods)

#### \_\_constructor

[](#__constructor)

```
  SpritesheetGenerator(tileWidth, tileHeight)
```

ParameterTypeDescription`tileWidth``integer`**Required**.`tileHeight``integer`**Required**.#### add images paths

[](#add-images-paths)

```
  ->addImagesPaths(imagesPaths)
```

ParameterTypeDescription`imagesPaths``array`**Required**.#### save generated spritesheet image

[](#save-generated-spritesheet-image)

```
  ->saveSpritesheetTo(srcSpritesheetPath)
```

ParameterTypeDescription`srcSpritesheetPath``string`**Optional**. default is './sprite-sheet.png'#### save css stylesheet

[](#save-css-stylesheet)

```
  ->saveStyleSheetTo(srcStylesheetPath, cssClassPrefix)
```

ParameterTypeDescription`srcStylesheetPath``string`**Optional**. default is './sprite-styles.css'`cssClassPrefix``string`**Optional**. default is 'sh-icon'#### generate images sprite sheet and css stylesheet

[](#generate-images-sprite-sheet-and-css-stylesheet)

```
  ->generateSheet()
```

Usage/Examples
--------------

[](#usageexamples)

```