npm install burner#Burner: A rendering engine for DOM-based animation.
Use Burner to setup a DOM-based rendering system in a web browser. Burner supplies some convenient functions for controlling playback, controlling the camera, detecting world boundaries, and optimizing object management via object pooling.
##Install
To include Burner as a component in your project, use the node module.
``
npm install burner --save
You can also use the standalone version and reference both the css and js files from your document.
`
...
##Usage
Burner contains the essential classes for creating a rendering engine... System, World and Item. You can use these built-in classes to create simple systems.
`
To create something more complex, you need supply a library of classes like FloraJS that inherit from the Item class.
A class must meet some minimum requirements:
* It must extend the Burner.Item class via Burner.Utils.extend. (ie. Burner.Utils.extend(Obj, Burner.Item))
* It must call Burner.Item in its constructor. (ie. Burner.Item.call(this))
You must add an entry for your class in Burner's 'Classes' map. Call setup() and pass a function that adds an instance of your class. Finally, call loop().
`html
`
Running the code, you should see a black box fall to the ground. The Item class has a default step() function that runs a gravity simulation.
You can override the default step() function to control your object's behavior any way you want.
##Docs
To learn more, please review the docs.
Building this project
------
This project uses Grunt. To build the project first install the node modules.
`
npm install
Next, run grunt.
`
grunt
To run the tests, run 'npm test'.
`
npm test
To check test coverage run 'grunt coverage'.
`
grunt coverage
A pre-commit hook is defined in /pre-commit that runs jshint. To use the hook, run the following:
`
ln -s ../../pre-commit .git/hooks/pre-commit
A post-commit hook is defined in /post-commit that runs the Plato complexity analysis tools. To use the hook, run the following:
`
ln -s ../../post-commit .git/hooks/post-commit
View the code complexity report.