adelciotto/leapmotion-prototype-template

A template for all the leapmotion game prototypes for COSC2408

leapmotion-prototype-template

This repository contains a basic template for our prototype leapmotion games. We use the Phaser game framework, and the Leap-Motion API.

View:

The template is running live here

Setting up the template

create a github repo for your prototype

On github, create a new repository and make sure to leave Initialize this repository with a README unchecked. Furthermore, leave Add .gitignore and Add a license to None

Note: When naming the repo, stick to the convention: your-prototype-name.

clone the repo

git clone https://github.com/adelciotto/leapmotion-prototype-template.git
your-prototype-name/
cd your-prototype-name

setup the template

run the install script:

./scripts/install.sh <your-github-username> <your-prototype-name>

Note: Please omit the brackets.

Developing a prototype

api reference

Please familiarise yourself with both the Phaser API and the Leap-Motion API.

npm tasks:

• npm run dev - Builds and scripts and assets in development mode, then hosts the game at localhost:8000. All source files and assets are watched and a browser reload will be triggered on any changes.
• npm run prod - Builds and scripts and assets in production mode, then hosts the game at localhost:8000.
• npm run build - Builds the scripts and assets in production mode. This means all source files are minified and all assets are optimised.

JS Conventions

We use Javascript ES6 in this project; which is compiled down to ES5 for browser compatibility using Babel. For a complete ES6 reference; go here

Stick to the JS coding conventions outlined here by airbnb

Deploying the game

push to gh-pages branch

To update the deployed game; please run the gh pages deploy script in the root directory:

./scripts/deploy

Note: only deploy when you feel you have something remotely playable