Awesome
Phaser 3 + TypeScript + Vite.js Template
Make Phaser 3 games with TypeScript and modern frontend tooling.
This is a TypeScript specific fork of phaser3-vite-template.
Prerequisites
You'll need Node.js and npm installed.
It is highly recommended to use Node Version Manager (nvm) to install Node.js and npm.
For Windows users there is Node Version Manager for Windows.
Install Node.js and npm with nvm:
nvm install node
nvm use node
Replace 'node' with 'latest' for nvm-windows.
Getting Started
You can clone this repository or use degit to scaffold the project like this:
npx degit https://github.com/ourcade/phaser3-typescript-vite-template my-folder-name
cd my-folder-name
npm install
Start development server:
npm run start
To create a production build:
npm run build
Production files will be placed in the dist folder. Then upload those files to a web server. 🎉
Project Structure
.
├── dist
├── node_modules
├── public
├── src
│ ├── HelloWorldScene.ts
│ ├── main.ts
├── index.html
├── package.json
TypeScript files are intended for the src folder. main.ts is the entry point referenced by index.html.
Other than that there is no opinion on how you should structure your project.
There is an example HelloWorldScene.ts file that can be placed inside a scenes folder to organize by type or elsewhere to organize by function. For example, you can keep all files specific to the HelloWorld scene in a hello-world folder.
It is all up to you!
Static Assets
Any static assets like images or audio files should be placed in the public folder. It'll then be served from the root. For example: http://localhost:8000/images/my-image.png
Example public structure:
public
├── images
│ ├── my-image.png
├── music
│ ├── ...
├── sfx
│ ├── ...
They can then be loaded by Phaser with this.image.load('my-image', 'images/my-image.png').
TypeScript ESLint
This template uses a basic typescript-eslint set up for code linting.
It does not aim to be opinionated.
See here for rules to turn on or off.
Dev Server Port
You can change the dev server's port number by modifying the vite.config.ts file. Look for the server section:
{
// ...
server: { host: '0.0.0.0', port: 8000 },
}
Change 8000 to whatever you want.