# phaser3-debug

> A simple debug scene for Phaser 3.

Latest version **0.1.2** (published 2019-04-18) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install phaser3-debug
pnpm add phaser3-debug
yarn add phaser3-debug
bun add phaser3-debug
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2019-04-18 |
| First published | 2019-04-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | GooeyWizard |
| Maintainers | gooeywizard |

## Links

- npm: https://www.npmjs.com/package/phaser3-debug
- Repository: https://github.com/gooeywizard/phaser3-debug
- Homepage: https://github.com/gooeywizard/phaser3-debug#readme
- Issues: https://github.com/gooeywizard/phaser3-debug/issues
- npm.io page: https://npm.io/package/phaser3-debug

## Dependencies (1)

- [phaser](https://npm.io/package/phaser.md) ^3.16.2

## Recent versions

- 0.1.2 (latest) — 2019-04-18
- 0.1.1 — 2019-04-18
- 0.1.0 — 2019-04-17

## README

# Phaser 3 Debug
A simple debug scene that makes it easy to 1) pause at any time and 2) see current stats on any or all sprites and bodies.

NOTE: There is currently no build version. If you want to use this in your own project, either copy the DebugScene.js file, or wait until I create a nice build you can import.

## Run the Demo
1) Clone this repository.
2) `npm install`
3) `npm start`

While it is running, press 'P' to pause/unpause.

## Configure the Debug Scene
To enable debug for an entity, set `debug = true` on the entity.
Example: `sprite.debug = true;`

When creating the debug scene, you can pass in a config object. The table below shows the properties you can configure.

| Property | Description | Default |
|----------|-------------|---------|
| `props` | An array of the propertys to display. | `['x','y','angle']` |
| `color` | The color of the debug text. | `'#da4d4d'` |
| `pauseKey` | The key to map to pause/unpause. | `'P'` |

---
_Source: https://npm.io/package/phaser3-debug · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._