Skip to content

A thin library on top of the HTML canvas element. The API is modeled after PyGame.

Notifications You must be signed in to change notification settings

SimonMcCallum/seriousgamejs

This branch is 20 commits ahead of, 177 commits behind GameJs/gamejs:master.

Folders and files

NameName
Last commit message
Last commit date
May 8, 2012
May 1, 2012
Jan 21, 2012
May 2, 2012
Jan 22, 2012
Feb 1, 2012
Oct 7, 2011
May 2, 2012
Jan 21, 2012
May 2, 2012
May 1, 2012
Jun 26, 2011

Repository files navigation

GameJs

GameJs is a JavaScript library for writing 2D games or other interactive graphic applications for the HTML Canvas http://gamejs.org.

Its API is modeled after the successful PyGame library http://pygame.org.

Usage

If you downloaded the git version, you will have to build the GameJs JavaScript file. Go to the GameJs directory and execute this in a unix shell or in git bash:

$ ./bin/minify-gamejs.sh

This should create a gamejs.min.js file in the GameJs home directory.

See the examples/skeleton/ directory for a minimal GameJs app. We recommend you also use this as the scaffolding if you want to create a new game yourself.

Note that you need to run the examples via http:// (not file://) unless you use Firefox or Safari. One trivial, cross-plattform solution to serve a directory via http is this executable: http://code.google.com/p/mongoose/.

Bundle your application for production

To wrap your own game's JavaScript files into one single file, use ./bin/minify-app.sh ./path-to-your-app/javascript/. You can also add a second argument compress to optionally minify the resulting JS file.

This will produce one file app.min.js holding all GameJs modules as well as your application code. You can then remove all <script> lines except the one loading the app.min.js file.

More Help

See the GameJs Website for more help or drop us an email in the Mailing List.

Check the docs folder of your GameJs installation.

Example application can be found in the examples/ directory.

GameJs Development

In production, an application uses a bundled JavaScript file which contains all GameJs modules (usually called gamejs.min.js). This is what all the examples do.

Thus if you modify the files below ./lib your changes won't show up in the examples unless you re-bundle the files with the ./bin/minify-gamejs.sh command

Unit Tests

We use QUnit https://github.com/jquery/qunit for the GameJs unit tests. Execute them by opening tests/index.html.

JsDoc

For the JavaScript documentation system, RingoJs must be installed on your system. This bash file will take care of rewriting the documentation into docs/api/:

$ ./bin/create-jsdoc.sh

About

A thin library on top of the HTML canvas element. The API is modeled after PyGame.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 99.4%
  • Other 0.6%