ardell/phaser-starter-kit

Phaser Ruby Starter Kit

Dependencies

• Git (on OS X install via homebrew)
• Ruby 2.1.2 (we recommend using RVM)

Installation

1. Clone this repository, e.g. git clone https://github.com/ardell/phaser-starter-kit.git penguin-wars where "penguin-wars" is the folder you want to build your game in.
2. cd penguin-wars again, where "penguin-wars" is the directory where you cloned the starter kit into.
3. bundle This installs ruby dependencies, such as your web server.

Building your game

You'll build your game in the public directory. We've started you out with Phaser's Hello World Example so all you should have to do is start building. public/index.html is the page that will be served at /, images, javascripts (js), and stylesheets (css) each have their own directory within public. Mostly you'll be working in public/js/app.js.

Running your game

Within your game directory, run foreman start, then go to http://localhost:5000 in your browser.

Deploying

To deploy your game to GitHub Pages...

1. Create a GitHub repository for your game.
2. Add your GitHub repository as a remote called "origin", e.g. git remote add origin git@github.com:username/repository.git where "username" is your GitHub username and "repository" is the name of the GitHub repository you created for your game.
3. Commit all changes that you want to be deployed.
4. Run rake deploy.
5. View your game at: https://[username].github.io/[repository] where "username" is your GitHub username and "repository" is the name of the GitHub repository you created for your game.