Another opinionated Phaser 3 plugin project starter with TypeScript, webpack, Sass, & jest.
Code style/formatting with ESLint & Prettier; pre-commit hook via Husky & lint-staged.
Create a new repository from this template - see Creating a repository from a template for more information.
Alternatively:
git clone https://github.com/agogpixel/phaser3-plugin-project-starter.git <repo>
cd <repo>
rm -rf .git
git init
git branch -M <branch-name>
git add .
git commit -m "Initial commit."
git remote add origin https://github.com/<account>/<repo>.git
git push -u origin <branch-name>Once the project template has been setup locally, install dependencies:
npm installSee the following for information on how plugins work in Phaser 3:
phaser3-plugin-project-starter/
|
├──.github/ * GitHub configurations.
| |
| ├──workflows/ * GitHub Actions configurations.
| | └──test.yml * Example CI configuration (on push, all branches).
| |
| └──CODEOWNERS * Define who is responsible for code in the repository.
│
├──.vscode/ * VSCode configurations.
| └──settings.json * Example configuration with auto-formatting on save.
│
├──src/ * Source files.
| |
| ├──lib/ * Library files.
| | |
| | ├──gameobjects/ * Phaser game objects.
| | | ├──example-gameobject.spec.ts * Example game object unit tests.
| | | └──example-gameobject.ts * Example game object.
| | |
| | ├──plugins/ * Phaser plugins.
| | | ├──example-global-plugin.spec.ts * Example global plugin unit tests.
| | | ├──example-global-plugin.ts * Example global plugin.
| | | ├──example-scene-plugin.spec.ts * Example scene plugin unit tests.
| | | └──example-scene-plugin.ts * Example scene plugin.
| | |
| | └──index.ts * Library public API.
| |
| └──index.ts * Export the library.
|
├──test/ * Testing resources.
| |
| ├──mocks/ * Testing mock files.
| | ├──file-mock.js * Mock module import of most binary resources.
| | └──style-mock.js * Mock module import of styles.
| |
| └──test-setup.ts * Setup the test environment.
|
├──.editorconfig * EditorConfig configurations.
├──.eslintrc * ESLint configurations.
├──.eslintignore * ESLint ignore file.
├──.gitignore * Git ignore file.
├──.npmrc * NPM configuration.
├──.prettierignore * Prettier ignore configuration.
├──.prettierrc * Prettier configuration.
├──jest.config.js * Jest test framework configuration.
├──LICENSE * Project license.
├──package-lock.json * Auto-generated NPM project configuration.
├──package.json * NPM project configuration.
├──README.md * Project README.
├──tsconfig.build.json * TypeScript configuration (builds).
├──tsconfig.json * TypeScript configuration (IDE & tests).
└──webpack.config.js * Webpack configuration.
Live development with jest --watch
npm startErrors & warnings output to stdout via eslint:
npm run lintAutomatically fix fomatting issues (careful):
npm run lint:fixUnit tests with coverage reporting output to coverage/ via jest:
npm testBuild output to dist/ via webpack:
npm run buildDiscuss the change you wish to make via issue or email.
Licensed under the MIT License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent