Gives structure to javascript games.
JavaScript CoffeeScript CSS
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
docs
example
lib
test
.gitignore
GruntFile.js
LICENSE.md
README.md
gust.min.js
package.json

README.md

Gust

Structure your javascript games.

Getting Started

sudo npm install gust -g
gust new mygame

cd newgame
npm install
sudo npm install grunt -g
grunt server

Syntax

var world = new Gust.World("#game-canvas");

var Monster = Class.extend({

   init: function(){
      Class.prototype.init.call(this);

      this.sprite = new Sprite();
   }

});

var monster = new Monster();

world.start();

About

Gust provides the ground work for setting up your javascript games. It does not provide, asset preloading, sound effects, canvas drawing, input support. The goal is to be a bare bones and extensible game framework showing you how to best setup your game.

Of course you'll need sprites, sound effects and asset preloading. Checkout the links below.

Gust uses a entity-system like architecture to handle updating / drawing logic. See the example game for usage.

Feature List

  • Grunt is used for task running
  • Fiber used for class creation, aliased to Class
  • Events class for handling events
  • Scene and SceneManager class deal with scene managment
  • World class that creates a canvas context and controls main loop
  • Map class to deal with multi-dimensional arrays
  • Group class contains nodes
  • Node class creates a connection between an entity and a system
  • System class is used to run actions on all nodes

Libraries

Gust is not a game engine and does not provide support for graphics, sounds, preloading, input. Gust is felxible enough to work with almost every library, so its easy to plugin whatever you like. Here is a list of awesome libraries you can use:

2D Graphics

3D Graphics

Math

Sound

Preloading

Input

Physics

Tasks

Animation

Utilities

Testing

Other

Find more tiny libraries here: microjs

Support

IE9+

Contributing

npm test will run the tests or grunt server to run tests in the browser. Fork and make a pull request.

MIT License

Copyright (C) 2013 Ben D'Angelo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.