Mobile Game

An example mobile game with use of Phaser, Parcel and Cordova.
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Building
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This mobile game template is a boilerplate with ready build and development flow. You could use it for prototyping your ideas, game jams, start point for game development or translating your browser games to mobile environment. Template uses assets from official Phaser platform game tutorial.

Main goals of project:

• Development and build flow ready - no time used for config
• Boilerplate for mobile games: assets, scenes and gameflow is implemented
• Mobile game comparison boilerplate - excellent for moving from browser to mobile

This template will be developed further on. There will be coming new features in future. You are encouraged to fill in requests through issues or PRs. All inputs are highly appreciated.

(back to top)

Built With

This game was built with following technologies.

• 
• 
• 

(back to top)

Getting Started

To start working with boilerplate, please follow instructions below.

Prerequisites

You need to have following packages installed to work with boilerplate

• npm

  npm install npm@latest -g

• parcel

  npm install parcel -g

• cordova

  npm install cordova -g

Installation

Please follow instructions below for installation and running of boilerplate

1. Clone the repo

   git clone https://github.com/michalzagrodzki/Project-Name.git

2. Install NPM packages

   npm install

3. Install browser platform for cordova

   cordova platform add browser

4. Run boilerplate through parcel

   npm run dev

Building

In order to build and run your boilerplate in emulator please follow instructions below

1. Build boilerplate through parcel

 npm run build

2. Run boilerplate in browser through cordova

 cordova run browser

3. Run boilerplate in iOS emulator through cordova

 cordova run ios

(back to top)

Usage

This boilerplate is a starting point for further development of games for mobile platforms.

Start with modyfing code in file game.js, and then add new scenes in folder src and include them in file index.js.

For guidance and examples how to develop games with Phaser, please refer to the Documentation

(back to top)

Roadmap

• Add Changelog
• Add Deployment Steps
• Add Additional Templates w/ Examples
• Add Support for Typescript
• Multi-language Support
  • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See license.txt for more information.

(back to top)

Contact

Michal Zagrodzki - @michalzagrodzki

Project Link: https://github.com/michalzagrodzki/phaser3-parcel-cordova-project-template

(back to top)

Acknowledgments

Following resources were helpful in building this boilerplate:

• Phaser3 documentation
• Parcel documentation
• Cordova documentation
• Best readme template

(back to top)