sveltekit-phaser

Boilerplate that integrates Phaser 3 into a SvelteKit project.

This project template has been set up using SvelteKit and includes:

• Typescript
• Tailwind
• ESLint
• Prettier
• Pre-commit hooks for ESLint and Prettier
• Code splitting

Build Setup

# 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 testing, i18n, or a database to your own project, you can do so quite easily with SvelteKit. Read the documentation to get familiar with the tool and the available add-ons. Also take a look at awesome-svelte.

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
   • src/routes/layout.svelte

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 SvelteKit and Phaser

You might want to expose some game state that lives inside of your Phaser code to your Svelte 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 Svelte components and Phaser modules. Both sides can then listen to and emit events on that emitter.

• Have both sides share a Svelte store instance. It works like an event emitter, but can also hold state. The Svelte store is nicely integrated into your Svelte components and has an accessible API that can be used in Phaser code as well.

Why not use the official template provided by the Phaser team?

The official Svelte template works perfectly fine if you prefer to use it. I decided to maintain my own template for the following reasons:

• The official template only works for building a fully browser rendered SPA. This template also works with SRR.
• The Phaser game should be code split from the rest of your UI by default.
• The official template does not cleanly separate Phaser from Svelte code. Svelte components should not call Phaser functions and vice versa. Any communication between the two frameworks should be handled via EventBus or a shared Svelte store. Not following this principle will result in hard to comprehend spaghetti code.
• A template should not contain too much boilerplate or example code that one has to delete.
• Linting, automatic code formatting and Tailwind are a must-have in any of my frontend projects and should therefore be included in a template that I want to use myself.