isomer: A JavaScript repository from allofthenorthwood

An isometric graphics library for HTML5 canvas.

View the official project page or try it out.

About

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);

Getting Started

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!

Build

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

$ npm install

Then run npm run dist:

$ npm run dist    # or, alternatively, `gulp dist`

> isomer@0.2.4 dist /Users/jordan/Projects/isomer
> gulp

[gulp] Using gulpfile ~/Projects/isomer/gulpfile.js
[gulp] Starting 'dist'...
[gulp] Finished 'dist' after 8.35 ms
[gulp] Starting 'default'...
[gulp] Finished 'default' after 6.52 μs

To generate isomer.js and isomer.min.js in the dist/ directory.

Develop

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

$ npm install
$ npm run dist

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

The test script (accessible via npm test) uses beefy to automatically rebuild Isomer on any file changes. This script also opens the testing page (located at http://localhost:9966/test/) in your default browser. The testing page includes a live reload script to refresh when Isomer is rebuilt.

$ npm test

> isomer@0.2.4 test /Users/jordan/Projects/isomer
> open http://localhost:9966/test/ && ./node_modules/.bin/beefy index.js:dist/isomer.js --live -- --standalone Isomer

listening on http://localhost:9966/
200   30ms    1.18KB /test/
200    8ms      508B /test/style.css
200    1ms    5.48KB /test/test.js
200  704ms    48.5KB /dist/isomer.js -> ./node_modules/.bin/browserify ./index.js --standalone Isomer -d

With node-canvas

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);

More Info

For more info, check out the official project page.