Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tbosak/game-template
Cross-platform project template using Electron and Angular with the Phaser game engine. Project utilizes flexbox directives for easy and responsive organization of components around the Phaser canvas.
https://github.com/tbosak/game-template
angular cross-platform css electron flexbox framework front-end game game-development html javascript nodejs npm phaser template typescript
Last synced: 9 days ago
JSON representation
Cross-platform project template using Electron and Angular with the Phaser game engine. Project utilizes flexbox directives for easy and responsive organization of components around the Phaser canvas.
- Host: GitHub
- URL: https://github.com/tbosak/game-template
- Owner: TBosak
- License: mit
- Created: 2020-05-01T17:56:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-11T04:26:27.000Z (about 1 year ago)
- Last Synced: 2024-10-15T03:06:19.687Z (22 days ago)
- Topics: angular, cross-platform, css, electron, flexbox, framework, front-end, game, game-development, html, javascript, nodejs, npm, phaser, template, typescript
- Language: TypeScript
- Homepage:
- Size: 1.1 MB
- Stars: 17
- Watchers: 5
- Forks: 3
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Coher3nTS Project
[](https://app.codacy.com/manual/TBosak/game-template?utm_source=github.com&utm_medium=referral&utm_content=TBosak/game-template&utm_campaign=Badge_Grade_Dashboard) [](https://github.com/TBosak/game-template/blob/master/LICENSE) [](https://gitter.im/Angular-Phaser-Electron-Template/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [](https://github.com/TBosak/game-template) [](https://github.com/TBosak/game-template) [](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2FTBosak%2Fgame-template)
This is an Angular project template with Phaser, set up to run with Electron.
### Cross-Platform & Responsive
The template should run on any desktop operating system.
Flexbox integration allows for extremely responsive design elements.
### Easy to Build
Build with HTML, CSS, and Typescript
---
## Getting Started
### Prerequisites
[Node.js and Angular CLI](https://angular.io/guide/setup-local)
(you shouldn’t need to go past step 1)
[Electron](https://www.electronjs.org/docs/tutorial/installation)
1. ```npm install electron -g``` to install electron globally & set path.
2. ```npm install``` in project root folder to ensure that all dependencies are installed.
### Running
```npm run-script start``` command in the project root folder will concurrently run ```ng serve``` and ```npm run-script electron``` to fire up the project. It takes a minute for serve to finish up. Will hopefully fix this soon to wait and reload electron automatically when angular finishes compiling.
---
## To Do
* Setting up config(s) to point at correct hosting environment(s) for the project in Electron's main.js
* Correctly exposing index.html to Electron as Angular runs (this has proven difficult to do in one run-script as you cannot chain commands with 'ng serve') - fixing this may fix item 1, as there will be no reference needed to host location.
* Need to make use of this template to find pain points between frameworks and correct them before they occur in use of the template, to optimize ease of implementation.
* Need to hide Electron toolbar, or bind to a boolean for end-user(developer).
* Need to turn template into an installable Angular schematics package.
* Add implementation example images and videos to README
* Need to setup custom component generation
* Need to integrate Electron forge for install generation of finished product(s)
---
## Built With
* [Angular](https://angular.io/) – The web framework used.
* [Phaser]( https://phaser.io/) – The game framework used.
* [Electron]( https://www.electronjs.org/) – The software framework used.
* [NodeJS](https://nodejs.org/en/) – The Javascript framework and package manager used.
* [Flexbox](https://github.com/angular/flex-layout) – The web layout model used.
## Authors
* **Tim Barani** - *Initial work* - [TBosak]( https://github.com/TBosak)
See also the list of [contributors](https://github.com/TBosak/game-template/graphs/contributors "contributors") who participated in this project.
---
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=V5LC4XTQDDE82&source=url)