gameloop-canvas
v1.1.2
Published
a gameloop designed for the html5 canvas tag
Downloads
15
Readme
gameloop-canvas
a gameloop designed for the html5 canvas tag.
includes the core methods/events of a game loop: start, end, pause, resume, update, draw
Designed for use with browserify.
Based on the gameloop module.
Requirements
- node.js
Install
npm install --save gameloop-canvas
Usage
Create a canvas and game object:
var game = require('gameloop-canvas')();
Possible options:
canvas
Can be an id of a canvas, a canvas element, or leave empty for the module to create and append the canvas to the document.body with an id of game.
width
Set the width of the game/canvas. Default: 1024px.
height
Set the height of the game/canvas. Default: 480px.
Example:
var Game = require('gameloop-canvas');
var game = Game({
canvas: 'id-of-canvas',
width: 500,
height: 500
});
Use update and draw events
game.on('update', function(dt){});
game.on('draw', function(context){});
Use start, pause, and resume methods
game.start();
game.end();
game.pause();
game.resume();
These methods have corresponding events:
game.on('start', function(){});
game.on('end', function(){});
game.on('pause', function(){});
game.on('resume', function(){});
Contributing
- Fork this repository.
- Create a branch for your changes.
- Include tests if applicable.
- Add/edit documentation for any changes.
- Submit a pull request.
License
MIT