# vue-phaserjs

[![Apache-2.0 licensed][badge-license]][url-license]
[![NPM version][badge-npm-version]][url-npm]
[![NPM downloads][badge-npm-downloads]][url-npm]
[![NPM Unpacked Size (with version)][badge-npm-unpacked-size]][url-npm]

Inspired by [phavuer](https://github.com/laineus/phavuer).

### Table of Contents

- 🚀 [Getting Started](#getting-started)
- 📖 [Documentation](#documentation)
- ⚖️ [License](#license)

---

## <a name="getting-started">🚀 Getting Started</a>

```bash
pnpm i vue-phaserjs vue phaser phaser3-rex-plugins pinia
```

Add [phaser.d.ts](https://github.com/Esposter/Esposter/blob/main/packages/app/shared/types/phaser.d.ts) and [vue-phaserjs.d.ts](https://github.com/Esposter/Esposter/blob/main/packages/app/shared/types/vue-phaser.d.ts) so `vue-phaserjs` can narrow down your scene key types + provide intellisense for custom plugins.

## <a name="documentation">📖 Documentation</a>

We highly recommend you take a look at the [documentation](https://esposter.com/docs/modules/vue-phaserjs.html) to level up.

### Usage

An example [implementation](https://github.com/Esposter/Esposter/blob/main/packages/app/app/pages/dungeons.vue).

## <a name="license">⚖️ License</a>

This project is licensed under the [Apache-2.0 license](https://github.com/Esposter/Esposter/blob/main/LICENSE).

[badge-license]: https://img.shields.io/github/license/Esposter/Esposter.svg?color=blue
[url-license]: https://github.com/Esposter/Esposter/blob/main/LICENSE
[badge-npm-version]: https://img.shields.io/npm/v/vue-phaserjs/latest?color=brightgreen
[url-npm]: https://www.npmjs.com/package/vue-phaserjs/v/latest
[badge-npm-unpacked-size]: https://img.shields.io/npm/unpacked-size/vue-phaserjs/latest?label=npm
[badge-npm-downloads]: https://img.shields.io/npm/dm/vue-phaserjs.svg