https://github.com/sun0fabeach/vue-phaser-vite

Vue 3 + Phaser 3 + Vite Template
https://github.com/sun0fabeach/vue-phaser-vite

boilerplate game-development phaser vite vue

Last synced: about 1 month ago
JSON representation

Vue 3 + Phaser 3 + Vite Template

• Host: GitHub
• URL: https://github.com/sun0fabeach/vue-phaser-vite
• Owner: Sun0fABeach
• License: mit
• Created: 2022-09-08T07:46:33.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-05-29T12:28:38.000Z (7 months ago)
• Last Synced: 2024-05-30T02:16:06.533Z (7 months ago)
• Topics: boilerplate, game-development, phaser, vite, vue
• Language: TypeScript
• Homepage:
• Size: 109 KB
• Stars: 24
• Watchers: 4
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vue-phaser-vite

#### Vite boilerplate that integrates Phaser 3 into a Vue 3 project.

This project template has been set up using **Vite** and includes:

* *Typescript*

* *Code Splitting*

* *Source Minification*

* *CSS Postprocessing*

## Build Setup

``` bash

# install dependencies

npm install

# serve with live reloading on localhost

npm run dev

# build for production

npm run build

# serve your production build on localhost

npm run preview

```

## Extending the project to your needs

If you want to add more features like *linting*, *unit testing* or *SCSS* to

your own project, you can do so quite easily with Vite. Read the

documentation to get

familiar with the tool. Also take a look at



awesome-vite for plugins and more.

## Converting into your own repository

If you want to maintain your own repo based on this boilerplate, you first need

to detach it from this repo. Here is what you need to do:

1. edit these files and enter your own project info

	* *package.json*

	* *README.md*

	* *index.html*

2. delete *LICENSE* (and perhaps add your own)

3. reinitialize git

rm -rf .git

git init

git add .

git commit -m "Initial commit"



## Sharing data between Vue and Phaser

You might want to expose some game state that lives inside of your Phaser code

to your Vue components and vice versa, for example a highscore. Here are two

ways you can achieve sharing state between the frameworks.

* Import a Phaser EventEmitter instance in

both your Vue components and Phaser modules. Both sides can then listen to and

emit events on that emitter.

* Have both sides share a 

Pinia store instance. It works like an event emitter, but can also hold

state. The Pinia store is nicely integrated into your Vue components and is easily

accessible on the Phaser side by applying the *useStore* hook.