Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michalzagrodzki/phaser3-parcel-cordova-project-template
A Phaser 3 + Parcel v2 + Cordova 11 bootstrap project for your next mobile game
https://github.com/michalzagrodzki/phaser3-parcel-cordova-project-template
bootstrap-project browser-games cordova game gamedev ios-app ios-game mobile-game parcel phaser-game phaser3 phaserjs project-template starter-template template-project
Last synced: 9 days ago
JSON representation
A Phaser 3 + Parcel v2 + Cordova 11 bootstrap project for your next mobile game
- Host: GitHub
- URL: https://github.com/michalzagrodzki/phaser3-parcel-cordova-project-template
- Owner: michalzagrodzki
- License: mit
- Created: 2022-10-04T19:18:35.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-31T16:14:29.000Z (about 2 years ago)
- Last Synced: 2024-11-17T05:45:11.969Z (2 months ago)
- Topics: bootstrap-project, browser-games, cordova, game, gamedev, ios-app, ios-game, mobile-game, parcel, phaser-game, phaser3, phaserjs, project-template, starter-template, template-project
- Language: JavaScript
- Homepage:
- Size: 471 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Mobile Game
An example mobile game with use of Phaser, Parcel and Cordova.
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://user-images.githubusercontent.com/4341982/195149956-d6fa9e17-c320-491a-a4f5-a365665dc961.jpg)
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.
### Built With
This game was built with following technologies.
* [![Phaser][Phaser]][Phaser-url]
* [![Parcel][Parcel]][Parcel-url]
* [![Cordova][Cordova]][Cordova-url]
## Getting Started
To start working with boilerplate, please follow instructions below.
### Prerequisites
You need to have following packages installed to work with boilerplate
* npm
```sh
npm install npm@latest -g
```
* parcel
```sh
npm install parcel -g
```
* cordova
```sh
npm install cordova -g
```
### Installation
Please follow instructions below for installation and running of boilerplate
1. Clone the repo
```sh
git clone https://github.com/michalzagrodzki/Project-Name.git
```
2. Install NPM packages
```sh
npm install
```
3. Install browser platform for cordova
```sh
cordova platform add browser
```
4. Run boilerplate through parcel
```sh
npm run dev
```
### Building
In order to build and run your boilerplate in emulator please follow instructions below
1. Build boilerplate through parcel
```sh
npm run build
```
2. Run boilerplate in browser through cordova
```sh
cordova run browser
```
3. Run boilerplate in iOS emulator through cordova
```sh
cordova run ios
```
## 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](https://phaser.io)_
## Roadmap
- [ ] Add Changelog
- [ ] Add Deployment Steps
- [ ] Add Additional Templates w/ Examples
- [ ] Add Support for Typescript
- [ ] Multi-language Support
- [ ] Spanish
See the [open issues](https://github.com/michalzagrodzki/phaser3-parcel-cordova-project-template/issues) for a full list of proposed features (and known issues).
## 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
## License
Distributed under the MIT License. See `license.txt` for more information.
## Contact
Michal Zagrodzki - [@michalzagrodzki](https://twitter.com/michalzagrodzki)
Project Link: [https://github.com/michalzagrodzki/phaser3-parcel-cordova-project-template](https://github.com/michalzagrodzki/phaser3-parcel-cordova-project-template)
## Acknowledgments
Following resources were helpful in building this boilerplate:
* [Phaser3 documentation](https://newdocs.phaser.io/docs/3.55.2)
* [Parcel documentation](https://parceljs.org/docs/)
* [Cordova documentation](https://cordova.apache.org/docs/en/11.x/)
* [Best readme template](https://github.com/othneildrew/Best-README-Template)
[contributors-shield]: https://img.shields.io/github/contributors/michalzagrodzki/phaser3-parcel-cordova-project-template.svg?style=for-the-badge
[contributors-url]: https://github.com/michalzagrodzki/phaser3-parcel-cordova-project-template/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/michalzagrodzki/phaser3-parcel-cordova-project-template.svg?style=for-the-badge
[forks-url]: https://github.com/michalzagrodzki/phaser3-parcel-cordova-project-template/network/members
[stars-shield]: https://img.shields.io/github/stars/michalzagrodzki/phaser3-parcel-cordova-project-template.svg?style=for-the-badge
[stars-url]: https://github.com/michalzagrodzki/phaser3-parcel-cordova-project-template/stargazers
[issues-shield]: https://img.shields.io/github/issues/michalzagrodzki/phaser3-parcel-cordova-project-template.svg?style=for-the-badge
[issues-url]: https://github.com/michalzagrodzki/phaser3-parcel-cordova-project-template/issues
[license-shield]: https://img.shields.io/github/license/michalzagrodzki/phaser3-parcel-cordova-project-template.svg?style=for-the-badge
[license-url]: https://github.com/michalzagrodzki/phaser3-parcel-cordova-project-template/blob/master/license.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/michaelzagrodzki/
[product-screenshot]: https://user-images.githubusercontent.com/4341982/195149956-d6fa9e17-c320-491a-a4f5-a365665dc961.jpg
[Phaser]: https://img.shields.io/badge/phaser3-000000?style=for-the-badge&logo=Lapce&logoColor=white
[Phaser-url]: https://phaser.io/
[Parcel]: https://img.shields.io/badge/Parcel-20232A?style=for-the-badge&logo=pkgsrc&logoColor=61DAFB
[Parcel-url]: https://parceljs.org/
[Cordova]: https://img.shields.io/badge/Cordova-35495E?style=for-the-badge&logo=Apache+Cordova&logoColor=4FC08D
[Cordova-url]: https://cordova.apache.org/