simple2d

Simple 2D for the web

Simple2D.js is intended to be an exact port of the native Simple 2D, written in JavaScript targeting modern browsers supporting WebGL. The API and feature set aims to be identical to the native version, as much as possible. Simple2D.js may differ only to conform to some JavaScript conventions or to address features and limitations of web browsers.

Building

Build, lint, and minify using Grunt:

npm install -g grunt-cli
npm install
grunt

The Google Closure Compiler is used to optimize and minify. The compiler is written in Java, so make sure the java command is available. To install Java on macOS, we recommend using Homebrew Cask:

brew tap caskroom/cask
brew cask install java

Tests

First, build the library using grunt, then open an HTML test file from the test/ directory in a browser.

Preparing a release

1. Run tests on all supported platforms
2. Update the version number in package.json
3. Run grunt to build the library
4. Commit all changes, including new builds
5. Create a new release in GitHub, with tag in the form v#.#.#
6. Run npm publish
7. 🎉