melonjs / Boilerplate

melonJS boilerplate

Sample project featuring :

• WebGL1 as default renderer
• Video autoscaling
• Mobile optimized HTML/CSS
• Swiping disabled on iOS devices
• Debug Panel (if #debug)
• Default icons
• asset file (resources.js) automatic generation
• distribution build
• Standalone build for desktop operating systems
• ES5 & ES6 shim for non compliant browser (see index.html)

To run distribution

To build, be sure you have node installed. Clone the project:

git clone https://github.com/melonjs/boilerplate.git

Then in the cloned directory, simply run:

[sudo] npm install

Running the game:

npm run serve

And you will have the boilerplate example running on http://localhost:8000

Building Release Versions

To build:

npm run build

This will create a build directory containing the files that can be uploaded to a server, or packaged into a mobile app.

Building a standalone desktop release:

npm run dist

Running the desktop release on Windows:

.\bin\electron.exe

Running the desktop release on macOS:

open ./bin/Electron.app

Running the desktop release on Linux:

./bin/electron

Note that you may have to edit the file Gruntfile.js if you need to better dictate the order your files load in. Note how by default the game.js and resources.js are specified in a specific order.

Note: by default the boilerplate will use the latest version of melonJS available on NPM, when deploying be sure to specify the version the game has been developed and tested against (e.g. updating the url in the index.html file to specify the 8.0.1 version : https://cdn.jsdelivr.net/npm/[email protected]/dist/melonjs.min.js). Also when used on production, it is strongly advised to remove the debug panel preload.

Copyright (C) 2011 - 2020 Olivier Biot melonJS is licensed under the MIT License