normalmap.js is a library for creating simple interactive lighting effects using normal maps.
JavaScript GLSL HTML CSS Shell

README.md

⚠️ THIS IS EXPERIMENTAL SOFTWARE ⚠️

normalmap.js

API | Example | Installation | Changelog | License (MIT) | Questions?

normalmap.js is a library for creating simple interactive lighting effects.

  • Built on top of WebGL
  • Simple to use
  • Small (~7kb gzipped)
  • Fast enough to run on modern smartphones
  • There is a tiny jQuery plugin for simple usage
  • Covered by automated end-to-end tests

Demos

Golden Dragon

Did you find a cool use for normalmap.js? Let me know!

Example

var lights = normalmap({
    canvas: canvas,
    normalMap: normalMap,
    baseColor: [0.5, 0.4, 0.5]
});

lights.clear();

var position = normalMap.vec3(0.5, 0.5, 1.0); // dead center
var color = normalMap.vec3(1.0, 1.0, 1.0); // bright white
lights.addPointLight(position, color);

Installation

With NPM:

$ npm install normalmap
var normalmap = require('normalmap');

With Bower: $ bower install normalmap

Or just download the latest zip file form the releases page.

Note that normalmap.js won't work with file:// urls. You will need to serve images from a webserver. See Richard Daveys phaser introduction for an explanations for this.

Browser Support

Normalmap.js should work in all browsers that supports WebGL.

API Documentation

doc/API.md

Changelog

doc/CHANGELOG.md

Creating normal maps

NormalMap-Online

Questions?

Create a github issue or tweet to @29a_ch and please be a bit patient. :)

License

Copyright © 2016 Jonas Wagner.

The source code of this project licensed under the MIT License (enclosed).

The images and textures used for demonstration purposes are not licensed under the MIT License and belong to their respective owners.