This project is a a boiler plate for a WebApp Game. This kind of game run on every target with modern web browsing capabilities while providing native feels to the user. Target supported by this boiler plate:
- Web browser : Chrome, Firefox etc...
- Mobile App: Android linux
- Desktop Application: Windows, Mac, Linux
The main source code use Phaser + React + Typescript to generate common static files.
React React makes it painless to create interactive UIs. Design simple views for each state in your application. This framework is used to make the UI of the game. This project was bootstrapped with Create React App. You can find the react guide here.
Phaser Phaser - A fast, fun and free open source HTML5 game framework. A Desktop and Mobile HTML5 game framework. A fast, free and fun open source framework for Canvas and WebGL powered browser games.
Typescript TypeScript is an open-source programming language developed and maintained by Microsoft. It is a strict syntactical superset of JavaScript, and adds optional static typing to the language. TypeScript is designed for development of large applications and transcompiles to JavaScript.
ionic / docker / electron Then 3 other frameworks are used to generate native target binary:
- Web browser: Docker Container (well docker is optional here but I like the concept)
- Mobile App: Ionic framework
- Desktop Application: Electron generate game executable with installer.
interesting source code files are in sub folder public and src
For quick start see the React documentation or execute:
npm install
npm start
the src folder is composed of 2 main part: the app part where you have regular React pages used to easily make menu and stuff. The game part where the library Phaser is used to effectively create the game.
To deploy a game with this starter use the underlining framework to generate your target. The code project from each framework is under their own respective directory. They are very simple sub project and you can read the documentation of each framework to understand how to use it. Sub Folder:
- docker : execute docker_build.bat to generate a docker container with the WebApp Game
- electron : execute electron_build.bat to generate a desktop executable and installer with the WebApp Game
- ionic: execute ionic_build.bat to generate android apk for phone