Skip to content

onmax/phaser-vue

Repository files navigation

Phaser Vue workspace

phaser-vue contains the Vue and Nuxt packages used to build Phaser games without hiding Phaser's scene model, plus the docs app, live playground, and examples used to develop the packages.

What you will find here

  • @onmax/phaser-vue for direct Vue 3 integration
  • @onmax/nuxt-phaser for the Nuxt wrapper and runtime defaults
  • docs/ for the documentation site
  • playground/ for the live Nuxt example app
  • examples/ for smaller focused package examples
  • skills/phaser-best-practices/ for local authoring guidance

Quickstart

If you want to work on the playground first:

pnpm install
pnpm dev:playground

Expected result: the Nuxt playground starts locally so you can validate scene wiring, bridge usage, and client-only mounting behavior.

Install the packages

pnpm add @onmax/phaser-vue phaser

For Nuxt, install both packages:

pnpm add @onmax/nuxt-phaser @onmax/phaser-vue phaser

Key links

Common workflows

pnpm build
pnpm test
pnpm typecheck
pnpm dev:docs
pnpm dev:playground

Testing model

The workspace now ships separate testing entrypoints for the published packages:

  • @onmax/phaser-vue/testing
  • @onmax/nuxt-phaser/testing

Use the Vue entrypoint for unit tests, component tests, and fake-runtime harnesses. Use the Nuxt entrypoint for mountSuspended() and renderSuspended() wrappers in Nuxt runtime tests.

Recommended layers:

  • Vitest + fake runtime for scene and component unit tests
  • Vitest Browser Mode for canvas and client-only smoke tests
  • Playwright for gameplay and end-to-end flows

Workspace layout

phaser-vue/
  docs/         # Docus site
  examples/     # Focused package examples
  packages/     # Published Vue and Nuxt packages
  playground/   # Nuxt demo app
  skills/       # Local authoring guidance

Related docs

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors