# phaser3-align-plugin

> ```bash yarn add phaser3-align-plugin ```

Latest version **1.2.3** (published 2020-09-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install phaser3-align-plugin
pnpm add phaser3-align-plugin
yarn add phaser3-align-plugin
bun add phaser3-align-plugin
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.3 |
| Published | 2020-09-11 |
| First published | 2020-09-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | liurongqing |
| Maintainers | liurongqing |
| Keywords | phaser3, phaser3-align-plugin |

## Links

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

## Recent versions

- 1.2.3 (latest) — 2020-09-11
- 1.2.2 — 2020-09-10
- 1.2.1 — 2020-09-10
- 1.2.0 — 2020-09-10
- 1.1.4 — 2020-09-10
- 1.1.3 — 2020-09-10
- 1.1.2 — 2020-09-10
- 1.1.1 — 2020-09-10
- 1.1.0 — 2020-09-10
- 1.0.10 — 2020-09-09
- 1.0.9 — 2020-09-09
- 1.0.8 — 2020-09-09
- 1.0.7 — 2020-09-09
- 1.0.6 — 2020-09-09
- 1.0.5 — 2020-09-09
- … 5 more at https://npm.io/package/phaser3-align-plugin/versions

## README

# Installation

```bash
yarn add phaser3-align-plugin
```

# Usage

1. Import the plugin
    ```typescript
    import { AlignPlugin } from 'phaser3-align-plugin'
    const config = {
        plugins: {
            scene: [
                {
                    key: 'AlignPlugin',
                    plugin: AlignPlugin,
                    mapping: 'align'
                }
            ]
        },
    }
    ```

1. Use it
    ```typescript
    // Scale
    this.align.envelop(sprite, 1)
    this.align.vw(sprite, 1)
    this.align.vh(sprite, 1)

    // Open grid
    this.align.grid({rows: 7, cols: 7, debug: true, color: 0xff0000})

    // position
    this.align.placeAt(sprite, row, col)
    this.align.placeAtIndex(sprite, index)
    ```

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