klimonte / isomer Goto Github PK

View the official project page or try it out.

Isomer is an easy-to-use graphics library for drawing isometric scenes.

var Shape = Isomer.Shape;
var Point = Isomer.Point;
var Color = Isomer.Color;
var red = new Color(160, 60, 50);
var blue = new Color(50, 60, 160);

iso.add(Shape.Prism(Point.ORIGIN, 3, 3, 1));
iso.add(Shape.Pyramid(Point(0, 2, 1)), red);
iso.add(Shape.Prism(Point(2, 0, 1)), blue);

First, grab a copy of Isomer here. You can also pay for it. Then, include the script wherever you see fit:

<script src="/path/to/isomer.min.js"></script>

After which you'll need to place a canvas in your document that we can later refer to. Be sure to give it a width and height.

<canvas width="800" height="600" id="art"></canvas>

Note (Optional): To improve the look of your canvas on retina displays, declare the width and height of your canvas element as double how you want it to appear. Then style your canvas with CSS to include the original dimensions.

#art {
  width: 400px;
  height: 300px;
}

At this point we can finally instantiate an Isomer object. Pass it a reference to your canvas like so:

var iso = new Isomer(document.getElementById("art"));

Now you're ready to start drawing!

Isomer uses Gulp as a build tool. To build the project, first install the dependencies.

$ npm install
$ npm install -g gulp

Then run:

$ gulp
[gulp] Using gulpfile /Users/jordan/Projects/isomer/gulpfile.js
[gulp] Starting 'build'...
[gulp] Finished 'build' after 6.47 ms
[gulp] Starting 'default'...
[gulp] Finished 'default' after 17 μs

To generate isomer.js in the build/ directory. For a minified build:

$ gulp release
[gulp] Using gulpfile /Users/jordan/Projects/isomer/gulpfile.js
[gulp] Starting 'build'...
[gulp] Finished 'build' after 4.13 ms
[gulp] Starting 'release'...
[gulp] Finished 'release' after 4.41 ms

This will generate build/isomer.min.js.

Isomer is developed using Browserify. Install dependencies and build the project like so:

$ npm install
$ npm install -g gulp
$ gulp

test/index.html contains a basic testing page that draws various shapes. This page will load the unminified bundle.

You will need to rebuild the project with gulp build to see your changes, or you can use beefy like so:

$ npm install -g beefy
$ beefy index.js:build/isomer.js --live
listening on http://localhost:9966/

Navigate to http://localhost:9966/test to load the testing page. Beefy will rebuild the project automatically when you make a change, and as a bonus, the testing page will reload thanks to an included livereload script.

Isomer also accepts the canvas provided by node-canvas, meaning you can generate isometric graphics on the command line.

var Canvas = require('canvas');
var canvas = new Canvas(400, 400);
var Isomer = require('isomer');   // npm install isomer
var fs = require('fs');
var out = fs.createWriteStream('output.png');

var iso = new Isomer(canvas);
iso.add(Isomer.Shape.Prism(Isomer.Point.ORIGIN));

canvas.pngStream().pipe(out);

For more info, check out the official project page.

MIT Licensed