https://github.com/webcaetano/image-scramble

Image Scramble with Seed
https://github.com/webcaetano/image-scramble

Last synced: 3 months ago
JSON representation

Image Scramble with Seed

• Host: GitHub
• URL: https://github.com/webcaetano/image-scramble
• Owner: webcaetano
• License: mit
• Created: 2015-10-28T18:33:53.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-08T00:36:39.000Z (over 10 years ago)
• Last Synced: 2026-02-08T14:26:30.919Z (4 months ago)
• Language: JavaScript
• Size: 660 KB
• Stars: 26
• Watchers: 2
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Image-scramble

[![npm version](https://img.shields.io/npm/v/image-scramble.svg?style=flat-square)](https://www.npmjs.com/package/image-scramble) 

[![Build Status](https://img.shields.io/travis/webcaetano/image-scramble.svg?style=flat-square)](https://travis-ci.org/webcaetano/image-scramble) 

[![npm donwloads](https://img.shields.io/npm/dm/image-scramble.svg?style=flat-square)](https://www.npmjs.com/package/image-scramble) 

![Bower version](https://img.shields.io/bower/v/unscramble-img.svg?style=flat-square)

Scramble/Unscramble Images

Very useful for protect canvas spritesheets.

### Example

#### Scramble (Server-Side)

![](http://i.imgur.com/4oReaij.png)

#### Unscramble (Client-Side)

![](http://i.imgur.com/AwfN1Gq.png)

### Usage Example

```javascript

var imgScramble = require('image-scramble');

imgScramble({

	image:'test/sample2.png', // source

	seed:'Kappa', // seed

	sliceSize:5, // slice size

	dest:'test/sample2_crop.png' // dest

},function(err){

	

})

```

## Options

#### image

- Path to image source Or Valid Buffer

#### seed

- Seed to shuffle in same sequence

#### sliceSize

- size of each slice

#### dest

- Destination of scrambled image

#### buffer 

- Return image as buffer

### Installation 

```

npm install image-scramble

```

## UnsrcambleImg (Client-Side)

#### Installation

```

bower install unscramble-img

```

#### Usage 

```javascript

// unscrambleImg(src,sliceSize,seed)

var canvas = unscrambleImg(img,sliceSize,'Kappa');

```

#### Phaser Example

```javascript

var bmp = unscrambleImg(img,sliceSize,'Kappa',game.add.bitmapData(img.width,img.height));

var sprite = game.add.sprite(0, 0, bmp);

```

## Gulp plugin

[gulp-image-scramble](https://github.com/webcaetano/gulp-image-scramble)