Note that due to the cross-origin request policy implemented in most browsers
(that prevents from accessing local files), you will need to either disable this
security check (see the tutorial), or better use a "personal" local web server
like the grunt connect task that is used for building melonJS (see below for building melonJS).

Building melonJS

For most users, all you probably want is to use melonJS, and all you need then is just to download the latest pre-built release to get started. The only time you should need to build melonJS is if you want to contribute to the project and start developing on it.

Both plain and minified versions of the library will be available under the "build" directory.

Building the documentation

Here is how you can build your own copy of the docs locally :

$ cd melonJS # if not already in the melonJS directory
$ grunt doc

The generated documentation will be available in the docs directory

Testing

The recommended way to test is to use the serve task:

$ grunt serve

Then navigate to http://localhost:8000/ in your browser. Stop the server when
you are done by pressing Ctrl+C in the terminal.

To run melonJS tests in node simply run the following:

$ grunt test

This will run the jasmine spec tests with the output displayed on the shell. Do
note that the latest Chrome version is required, as the test unit will run the
Browser in a headless mode (in case of failed tests, upgrade your browser).

WIP Builds

melonJS uses Travis-CI for automated testing and build uploads. The latest build
artifacts can be downloaded from the melonjs-builds
bucket.

Questions, need help ?

If you need technical support, you can contact us through the following channels :