Skip to content
This repository has been archived by the owner on Jan 19, 2022. It is now read-only.

Latest commit

 

History

History
79 lines (49 loc) · 4.14 KB

README.md

File metadata and controls

79 lines (49 loc) · 4.14 KB

WebGameStub

WebGameStub helps you get a quick and easy start on writing an HTML5 game with 2D canvas with a simple template and a few tools. WebGameStub offers a good starting point for the game itself and smoothes off a variety of the rough edges associated with writing and publishing a Web game.

WebGameStub is about saving you time and effort so that you can focus on writing your game. It's about not having to write the most basic game infrastructure pieces, like canvas setup and an update/render loop. It's about having an easier starting point than a blank canvas. It's about not having to spend your time stitching together the usual cross-browser bits associated with bootstrapping an app on the web. And once you've got a game you're proud of, it's about making it easy to publish into the app stores on the web, including the new Mozilla Marketplace.

Getting started

  • Download the current version of this project from the downloads page
  • Open the index.html file in the www folder in a web browser
  • Edit the application in www/js/app.js and then reload the index.html file to see how your changes affect the game

#Extra Features (requires node.js)

<Don't really have the knowledge needed to write this section>

Install node.js first

  • Go to nodejs
  • Download and install whatever package is appropriate for your platform

Optimize for high performance

volo build+minify

Deploy to github pages

volo ghdeploy

Simple library installation

volo add <The instructions for using the extra features needs more detail, and probably some concrete examples.> <Yeah, I know. I don't know how to use these tools, so the descriptions here could probably be done much more quickly by someone else>

Publishing your game

Once your game is finished, you can publish it to a number of web marketplaces in order to reach your audience.

Mozilla Marketplace

To publish your game to the Mozilla Marketplace:

  1. Edit the application manifest template www/game.webapp in your project directory and fill in the required fields. Additional documentation for the mainfest file format is available here. Note that you are free to rename game.webapp to something else.

  2. Check that your manifest is correct using the App Manifest tool.

  3. Visit the Mozilla Marketplace and follow the instructions for submitting your application.

Chrome Web Store

To publish your game to the Chrome Web Store:

  1. Edit the application manifest template www/manifest.json in your project directory and fill in the require fields. Additional documentation for the manifest file format is available here.
  2. Follow the instructions in the developer tutorial.

More Resources

Game APIs

2D Art

Getting involved

Join us on #games on irc.mozilla.org and message dmose, ack, or dperit if you want to get involved and contribute to Webgamestub. We also welcome any feedback and input that you have to offer! Issues can be filed on https://github.com/mozilla/WebGameStub/issues