update

.gitattributes

@@ -0,0 +1,2 @@
+*.js linguist-detectable=false
+*.html linguist-detectable=false

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: yandeu

.github/workflows/main.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Build Packages
+        run: npm run build

.gitignore

@@ -0,0 +1,3 @@
+/.cache
+/dist
+/node_modules

.npmrc

@@ -0,0 +1 @@
+engine-strict=true

.prettierrc

@@ -0,0 +1 @@
+"@yandeu/prettier-config"

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode"]
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c)  2021 Yannick Deubel (https://github.com/yandeu); Project Url: https://github.com/yandeu/phaser-project-template
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,209 @@
+<h1 align="center">
+  <br>
+  <a href="https://github.com/yandeu/phaser-project-template#readme"><img src="readme/header.png" alt="header" width="600"></a>
+  <br>
+  Phaser 3 TypeScript Starter Template
+  <br>
+</h1>
+
+<h4 align="center">
+A starter template for <a href="https://phaser.io/" target="_blank" >Phaser 3</a> with <a href="https://www.typescriptlang.org/index.html" target="_blank" >TypeScript</a> and <a href="https://webpack.js.org/" target="_blank" >webpack</a> for building excellent html5-games that work great in the browser and on mobile devices.</h4>
+
+<p align="center">
+  <a href="https://opensource.org/licenses/MIT" title="License: MIT" >
+    <img src="https://img.shields.io/badge/License-MIT-greenbright.svg?style=flat-square">
+  </a>
+  <img src="https://img.shields.io/github/package-json/v/yandeu/phaser-project-template.svg?style=flat-square" alt="GitHub package.json version">
+  <img src="https://img.shields.io/github/last-commit/yandeu/phaser-project-template.svg?style=flat-square" alt="GitHub last commit">
+  <a href="https://github.com/prettier/prettier" alt="code style: prettier"><img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"></a>
+</p>
+
+<p align="center">
+  <a href="#key-features">Key Features</a> •
+  <a href="#preview">Preview</a> •
+  <a href="#how-to-use">How To Use</a> •
+  <a href="#enable3d">enable3d</a> •
+  <a href="#progressive-web-app-pwa">PWA</a> •
+  <a href="#native-app">Native App</a> •
+  <a href="#custom-configurations">Custom Configurations</a> •
+  <a href="#es6">ES6</a> •
+  <a href="#useful-links">Useful Links</a> •
+  <a href="#multiplayer-game">Multiplayer Game</a> •
+  <a href="#examples">Examples</a> •
+  <a href="#credits">Credits</a> •
+  <a href="#license">License</a>
+</p>
+
+<blockquote align="center">
+ Want to use ES6 instead of TypeScript? Check out the <a href="https://github.com/yandeu/phaser-project-template-es6#readme" >phaser-project-template-es6</a>
+</blockquote>
+
+---
+
+## Key Features
+
+- **ESNext** features ready (async/await, Rest/Spread operators)
+- Code Splitting
+- Obfuscation
+- Development Server with SourceMap and Live-Reload
+- PWA ready with offline support and "Add to Home screen" install prompt
+- Easy to build Native App using Capacitor
+- Includes Phaser 3 TypeScript typings
+- For development and production builds
+- Adds a webpack ContentHash to the JavaScript files (in production)
+
+## Preview
+
+This is what you get after installing this template. A simple and clean starter template written in TypeScript. [Try it!](https://s3.eu-central-1.amazonaws.com/phaser3-typescript/starter-template/index.html)
+
+<a href="https://s3.eu-central-1.amazonaws.com/phaser3-typescript/starter-template/index.html">
+<img src="readme/screenshot.png" width="640" style='border: 0.25em solid #e1e4e8;border-radius: 20px;'/>
+</a>
+
+## How To Use
+
+To clone and run this template, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:
+
+```bash
+# Clone this repository (yes, npx not npm)
+$ npx gitget yandeu/phaser-project-template phaser-template
+
+# Go into the repository
+$ cd phaser-template
+
+# Install dependencies
+$ npm install
+
+# Start the local development server (on port 8080)
+$ npm start
+
+# Ready for production?
+# Build the production ready code to the /dist folder
+$ npm run build
+
+# Play your production ready game in the browser
+$ npm run serve
+```
+
+Change the **gameName** in /webpack/webpack.common.js.
+
+All your game code lies inside the **/src/scripts** folder. All assets need to be inside the **/src/assets** folder in order to get copied to /dist while creating the production build. Do not change the name of the index.html and game.ts files.
+
+## enable3d
+
+<a href="https://github.com/yandeu/enable3d#readme"><img src="readme/enable3d-logo.png" alt="enable3d logo" width="300"></a>
+
+Want to add 3D objects and physics to your Phaser game? Checkout [enable3d](https://github.com/yandeu/enable3d#readme)!
+
+## Progressive Web App (PWA)
+
+![PWA](readme/pwa.png)
+
+This template is **100% PWA ready**.
+
+The ServiceWorker is **disabled by default** and is configured to only work in **production mode**.  
+Uncomment the line below inside /src/index.html to enable it.
+
+```html
+<script>
+  if ('serviceWorker' in navigator) {
+    window.addEventListener('load', () => {
+      navigator.serviceWorker.register('./sw.js')
+    })
+  }
+</script>
+```
+
+You can easily personalize its settings by following these steps:
+
+- Replace both icons in /pwa/icons with your own.
+  - One is **512x512** the other **192x192**
+- Add your own **favicon.ico** to /src
+- Adjust these parameters in the **manifest.json** file in /pwa
+  - **short_name**: Max. 12 characters
+  - **name**: The full game name
+  - **orientation**: "landscape" or "portrait"
+  - **background_color**: color of the splash screen
+  - **theme_color**: color of the navbar - has to match the theme-color in the index.html file
+- You can leave the **sw.js** (serviceWorker) in /pwa how it is.
+- Change the **gameName** in /webpack/webpack.common.js
+
+Read more about PWA on [developers.google.com](https://developers.google.com/web/progressive-web-apps/)
+
+## Native App
+
+The simplest way to build a Native App is using https://html2app.dev/.
+
+Or built it manually using [Capacitor](https://capacitor.ionicframework.com/) and following its [Documentation](https://capacitor.ionicframework.com/docs/).  
+The only thing you need to change after installing Capacitor is the **webDir** inside the **capacitor.config.json** file. Set it to **dist** like so:
+
+```json
+{
+  "appId": "com.example.app",
+  "appName": "YOUR_APP_NAME",
+  "bundledWebRuntime": false,
+  "webDir": "dist"
+}
+```
+
+## Custom Configurations
+
+### TypeScript Compiler
+
+Change the TypeScript compiler's settings in the tsconfig.json file.
+
+If you are new to TypeScript, you maybe want to set **"noImplicitAny"** to **false**.
+
+You'll find more information about the TypeScript compiler [here](https://www.typescriptlang.org/docs/handbook/compiler-options.html).
+
+### Typings
+
+You can put your custom type definitions inside typings/**custom.d.ts**.
+
+### Webpack
+
+All webpack configs are in the **webpack** folder.
+
+### Obfuscation
+
+_Obfuscation is disabled by default._
+
+We are using the [webpack-obfuscator](https://github.com/javascript-obfuscator/webpack-obfuscator). Change its settings in webpack/webpack.prod.js if needed. All available options are listed [here](https://github.com/javascript-obfuscator/javascript-obfuscator#javascript-obfuscator-options).
+
+## ES6
+
+Want to use ES6 instead of TypeScript? Switch to the [phaser-project-template-es6](https://github.com/yandeu/phaser-project-template-es6#readme)
+
+## Multiplayer Game
+
+Making a multiplayer game? Check out [geckos.io](https://github.com/geckosio/geckos.io#readme)
+
+## Useful Links
+
+- [Phaser Website](https://phaser.io/)
+- [Phaser 3 Forum](https://phaser.discourse.group/)
+- [Phaser 3 API Docs](https://photonstorm.github.io/phaser3-docs/)
+- [Official Phaser 3 Examples](http://labs.phaser.io/)
+- [Notes of Phaser 3](https://rexrainbow.github.io/phaser3-rex-notes/docs/site/index.html)
+
+## Examples
+
+### Game Examples Built with this Starter Template
+
+#### Platformer Example [[Play this game](https://s3.eu-central-1.amazonaws.com/phaser3-typescript/platformer-example/index.html) - [Visit its Repository](https://github.com/yandeu/phaser3-typescript-platformer-example#readme)]
+
+[![phaser3-typescript-platformer](https://raw.githubusercontent.com/yandeu/phaser3-typescript-platformer-example/master/screenshots/nexus6-640x360.png)](https://github.com/yandeu/phaser3-typescript-platformer-example#readme)
+
+#### Phaser 3 + Matter.js: Car Example [[Play this game](https://s3.eu-central-1.amazonaws.com/phaser3-typescript/car-on-curved-tarrain/index.html) - [Visit its Repository](https://github.com/yandeu/phaser3-matter-car-on-curved-terrain#readme)]
+
+<a href="https://github.com/yandeu/phaser3-matter-car-on-curved-terrain#readme">
+<img src="https://raw.githubusercontent.com/yandeu/phaser3-matter-car-on-curved-terrain/master/readme/myimage.gif" width="640" alt="phaser3-matter-car-example">
+</a>
+
+## Credits
+
+A huge thank you to Rich [@photonstorm](https://github.com/photonstorm) for creating Phaser
+
+## License
+
+The MIT License (MIT) 2021 - [Yannick Deubel](https://github.com/yandeu). Please have a look at the [LICENSE](LICENSE) for more details.