Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 1.47 KB

README.md

File metadata and controls

43 lines (33 loc) · 1.47 KB
Raw

Polar.js

documentation | npm | github

Polar.js is a WebGL-based game engine we wrote back in highschool. This video is a good showcase of what it can do.

Getting Started

// Add some example code here

Usage

Web

<script src="unpkg.com/polar.js/umd/polar.min.js"></script>

The package is hosted on npm, so can be easily accessed through the UNPKG CDN. For the latest minified version use the example above or specify a semver version (i.e. unpkg.com/[email protected]/polar.min.js). Please refer to the UNPKG site for more details.

Npm

npm install polar.js

Alternatively, you can bundle the engine with your app seperately by downloading the package with npm.

Showcase

https://youtu.be/ZVPHzbGP_gs

Contribute

Feel free to fork a recent commit to add, edit or optimise the engine.

If you think your additions are worthy of the master branch, create a pull request. To make my life easier:

  • Originate your branch from a recent commit.
  • Include a brief description of what you changed.
  • Include a brief explanation of why you changed it.

Credits

Created by Alex Brown, Harry Ickeringill and Jake Palandri.