This is a Phaser 3 project template that uses the Vue framework, TypeScript and Vite for bundling. It includes a bridge for Vue to Phaser game communication, hot-reloading for quick development workflow and scripts to generate production-ready builds.
This Template is also available as a JavaScript version.
This template has been updated for:
Node.js is required to install dependencies and run scripts via npm
.
Command | Description |
---|---|
npm install |
Install project dependencies |
npm run dev |
Launch a development web server |
npm run build |
Create a production build in the dist folder |
After cloning the repo, run npm install
from your project directory. Then, you can start the local development server by running npm run dev
.
The local development server runs on http://localhost:8080
by default. Please see the Vite documentation if you wish to change this, or add SSL support.
Once the server is running you can edit any of the files in the src
folder. Vite will automatically recompile your code and then reload the browser.
We have provided a default project structure to get you started. This is as follows:
index.html
- A basic HTML page to contain the game.src
- Contains the Vue source code.src/main.ts
- The main Vue entry point. This bootstraps the Vue application.src/vite-env.d.ts
- Global TypeScript declarations, provide types information.src/App.vue
- The main Vue component.src/game/PhaserGame.vue
- The Vue component that initializes the Phaser Game and serve like a bridge between Vue and Phaser.src/game/EventBus.ts
- A simple event bus to communicate between Vue and Phaser.src/game
- Contains the game source code.src/game/main.ts
- The main game entry point. This contains the game configuration and start the game.src/game/scenes/
- The Phaser Scenes are in this folder.public/style.css
- Some simple CSS rules to help with page layout.public/assets
- Contains the static assets used by the game.
The PhaserGame.vue
component is the bridge between Vue and Phaser. It initializes the Phaser game and passes events between the two.
To communicate between Vue and Phaser, you can use the EventBus.ts file. This is a simple event bus that allows you to emit and listen for events from both Vue and Phaser.
// In Vue
import { EventBus } from './EventBus';
// Emit an event
EventBus.emit('event-name', data);
// In Phaser
// Listen for an event
EventBus.on('event-name', (data) => {
// Do something with the data
});
In addition to this, the PhaserGame
component exposes the Phaser game instance along with the most recently active Phaser Scene. You can pick these up from Vue via (defineExpose({ scene, game }))
.
Once exposed, you can access them like any regular state reference.
In Phaser, the Scene is the lifeblood of your game. It is where you sprites, game logic and all of the Phaser systems live. You can also have multiple scenes running at the same time. This template provides a way to obtain the current active scene from Vue.
You can get the current Phaser Scene from the component event "current-active-scene"
. In order to do this, you need to emit the event "current-scene-ready"
from the Phaser Scene class. This event should be emitted when the scene is ready to be used. You can see this done in all of the Scenes in our template.
Important: When you add a new Scene to your game, make sure you expose to Vue by emitting the "current-scene-ready"
event via the EventBus
, like this:
class MyScene extends Phaser.Scene
{
constructor ()
{
super('MyScene');
}
create ()
{
// Your Game Objects and logic here
// At the end of create method:
EventBus.emit('current-scene-ready', this);
}
}
You don't have to emit this event if you don't need to access the specific scene from Vue. Also, you don't have to emit it at the end of create
, you can emit it at any point. For example, should your Scene be waiting for a network request or API call to complete, it could emit the event once that data is ready.
Here's an example of how to access Phaser data for use in a Vue Component:
// In a parent component
<script setup lang="ts">
import { ref, toRaw } from 'vue';
const phaserRef = ref();
const game = toRaw(phaserRef.value.game) as Phaser.Game;
const scene = toRaw(phaserRef.value.scene) as Phaser.Scene;
const onCurrentActiveScene = (scene) => {
// This is invoked
}
</script>
<template>
<PhaserGame ref="phaserRef" @current-active-scene="onCurrentActiveScene" />
</template>
In the code above, you can get a reference to the current Phaser Game instance and the current Scene by calling ref()
.
From this state reference, the game instance is available via toRaw(phaserRef.value.game)
and the most recently active Scene via toRaw(phaserRef.value.scene)
The onCurrentActiveScene
callback will also be invoked whenever the the Phaser Scene changes, as long as you emit the event via the EventBus, as outlined above.
Vite supports loading assets via JavaScript module import
statements.
This template provides support for both embedding assets and also loading them from a static folder. To embed an asset, you can import it at the top of the JavaScript file you are using it in:
import logoImg from './assets/logo.png'
To load static files such as audio files, videos, etc place them into the public/assets
folder. Then you can use this path in the Loader calls within Phaser:
preload ()
{
// This is an example of an imported bundled image.
// Remember to import it at the top of this file
this.load.image('logo', logoImg);
// This is an example of loading a static image
// from the public/assets folder:
this.load.image('background', 'assets/bg.png');
}
When you issue the npm run build
command, all static assets are automatically copied to the dist/assets
folder.
After you run the npm run build
command, your code will be built into a single bundle and saved to the dist
folder, along with any other assets your project imported, or stored in the public assets folder.
In order to deploy your game, you will need to upload all of the contents of the dist
folder to a public facing web server.
If you want to customize your build, such as adding plugin (i.e. for loading CSS or fonts), you can modify the vite/config.*.mjs
file for cross-project changes, or you can modify and/or create new configuration files and target them in specific npm tasks inside of package.json
. Please see the Vite documentation for more information.
We love to see what developers like you create with Phaser! It really motivates us to keep improving. So please join our community and show-off your work ๐
Visit: The Phaser website and follow on Phaser Twitter
Play: Some of the amazing games #madewithphaser
Learn: API Docs, Support Forum and StackOverflow
Discord: Join us on Discord
Code: 2000+ Examples
Read: The Phaser World Newsletter
Created by Phaser Studio. Powered by coffee, anime, pixels and love.
The Phaser logo and characters are ยฉ 2011 - 2024 Phaser Studio Inc.
All rights reserved.