jojoee/pixel-mask-generator

:video_game: :game_die: Procedural pixel generator (mask) + visualizer

pixel-mask-generator

Very inspired and copy some code from zfedoran/pixel-sprite-generator

Installation

// npm
npm install pixel-mask-generator --save
const pmg = require('pixel-mask-generator')

// Bower
bower install pixel-mask-generator --save
<script src="bower_components/pixel-mask-generator/dist/index.js"></script>

Example usage

const mask = new pmg.Mask([
  0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 1, 1,
  0, 0, 0, 0, 1, -1,
  0, 0, 0, 1, 1, -1,
  0, 0, 0, 1, 1, -1,
  0, 0, 1, 1, 1, -1,
  0, 1, 1, 1, 2, 2,
  0, 1, 1, 1, 2, 2,
  0, 1, 1, 1, 2, 2,
  0, 1, 1, 1, 1, -1,
  0, 0, 0, 1, 1, 1,
  0, 0, 0, 0, 0, 0
], 6, true, false)
const sprite = new pmg.Sprite(mask)
sprite.generate()

// resize and append
const resizedSpriteCanvasEle = pmg.util.resize(sprite.canvas, 10)
const body = document.body
body.appendChild(resizedSpriteCanvasEle)

Note

• Compatible with all browsers
• Unit test: add more tests
• Automated scripts: browser compatibility test
• Automated scripts: deploy to gh-pages
• Branch: split code from master and gh-pages
• Dependency: split static/random.js to another repository
• Dependency: split resize function to another repository
• Mask: add more masks
• Demo: update demo page
• Coverage: increase coverage threshold
• Article: copy original article into the repo, in case the site and mirror are down
• Algorithm: change algorithm toward to the original, should be symmetrical

Contribute for owner

$ npm install -g semantic-release-cli
$ semantic-release-cli setup

Using above command to setup "semantic-release"

Contribute

1. Fork the repo
2. Install Node.js and dependencies
3. Make a branch for your change and make your changes
4. Run git add -A to add your changes
5. Run npm run commit (don't use git commit)
6. Push your changes with git push then create Pull Request

Reference

• zfedoran/pixel-sprite-generator
• blipn/pixel-sprite-generator-nodejs
• HSL and HSV