gmsmith's Introduction

gmsmith

Requirements

gmsmith depends on gm which depends on Graphics Magick.

I have found it is best to install from the site rather than through a package manager (e.g. apt-get) to get the latest as well as without transparency issues.

This module has been developed and tested against 1.3.17.

Alertnatively, you can use ImageMagick which is implicitly discovered if gm is not installed. http://www.imagemagick.org/script/index.php

Getting Started

Install the module with: npm install gmsmith

// Convert images into gmsmith objects
var images = ['img1.jpg', 'img2.png'];
gmsmith.createImages(this.images, function handleImages (err, imgs) {
  // Create a canvas to draw onto (200 pixels wide, 300 pixels tall)
  gmsmith.createCanvas(200, 200, function (err, canvas) {
    // Add each image at a specific location (upper left corner = {x, y})
    var coordinatesArr = [{x: 0, y: 0}, {x: 50, y: 50}];
    imgs.forEach(function (img, i) {
      var coordinates = coordinatesArr[i];
      canvas.addImage(img, coordinates.x, coordinates.y);
    }, canvas);

    // Export canvas to image
    canvas['export']({format: 'png'}, function (err, result) {
      result; // Binary string representing a PNG image of the canvas
    });
  });
});

Documentation

This module was built to the specification for all spritesmith modules.

https://github.com/twolfson/spritesmith-engine-test

canvas['export'](options, cb)

These are options specific gmsmith

options Object
- quality Number - Quality of output image on a scale from 0 to 100

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint using npm run lint and test via npm test.