How to install the game

• Install git
  • Here's an installion guide for git
• Install github (optional)
  • Here's a link to installing the desktop version of github
• Install nodeJs
  • This will automatically install npm which is used to run the game
  • Linux/Ubuntu/Debian command to install nodeJs is sudo apt-get install nodejs npm
  • Here's a guide for the Windows Installation of NodeJs
  • Here's a guide for the Mac Installation of NodeJs
• Inside commandline navigate to "eansPhaserBoilerPlate" folder
  • This should be achieved by entering cd eanPhaserBoilerPlate
• In command line run npm install
  • Our backend uses nodejs so this will install the resources our projects needs to run independently

How to run the game

• Inside commandline navigate to "eansPhaserBoilerPlate" folder (if you're not already there)
  • This should be achieved by entering cd eanPhaserBoilerPlate
• In command line run npm start
  • This script actually starts up our server (which means our game is running)
• Open up a web browser and go to this address http://localhost:7777
  • http://127.0.0.1:7777 also works because these are representations of the "home" address
• From here you'll be able to play the game!

Naming Convention

• camel casing
  • applies to coding, files, and folders
  • example: var name = "eanCharacter"
• no capitalizing 1st letters

Basic Source Control (using git)

• When submitting a change ALWAYS commit then pull, before you push!
  • git add -A (tracks files and adds them to staging)
  • git commit -m "adding my file msg" (timestamps your changes to the repository)
  • git pull origin master (pulls latest changes from repository)
  • git push origin master (pushes your updated changes to repository for other people to pull)
  • Sometimes a push or pull may result in a merge conflict, when this happens just make resolve the conflict by updating files to their correct version manually.

Pipeline

• Generic Asset Integration
  • Art, sounds, json files, or any file that does not contain game logic can be considered a generic asset
  • Before any assets are created make sure any specs are documented
  • Assets that are complete should be inserted into the assetDump directory
  • If assets matches specs then a technical artist can add them to correct part of repository
  • Make sure to update any indexes and dependency references (like index.html) so assets can be loaded into the game

Description

Game Development Tool to create awesome Html5 games using Phaser Framework. Useful tool for those new to the world of Phaser. Speed up your work with a simple download!

"An easy to install set of skeleton classes to speed-up development start time." - Richard Darvey

Features:

• Phaser 2.9.2. (minified).
• Some plugins for better performance.
• Develop in State mode: StateManager, Boot, Load & Menu.
• Load Assets: Boilerplate Logo.

Plugins Installed:

• Phaser-Debug v1.1.9
• Phaser-Inspector v0.1
• Phaser-Isometric v0.9.4
• Phaser-Input v2.0.5
• Phaser-SuperStorage v1.0.4

To Install:

Clone the git repo: git clone https://github.com/DallOner/Phaser-Boilerplate.git

Or checkout the Tagged Release you'd like to use.

Credits

englercj, netcell, lewster32, Orange Games...

Special Thanks to all those people who have given me support and their valuable feedback