spriter-phaser

Spriter runtime plugin for Phaser 4.

Load .scon + TexturePacker atlas, create characters with a simple API, play animations, swap skins, aim bones, and read points/boxes.

Install

npm install spriter-phaser phaser

Peer dependency: phaser@^4.2.1

Quick start

import Phaser from "phaser";
import { SpriterPlugin, SpriterObject } from "spriter-phaser";

const config: Phaser.Types.Core.GameConfig = {
  type: Phaser.AUTO,
  width: 800,
  height: 600,
  plugins: {
    global: [{ key: "SpriterPlugin", plugin: SpriterPlugin, start: true }],
  },
  scene: [MainScene],
};

class MainScene extends Phaser.Scene {
  private hero!: SpriterObject;

  preload() {
    this.load.spriter(
      "boy",
      "assets/boy/boy.scon",
      "assets/boy/boy.json",
      "assets/boy/boy.png",
    );
  }

  create() {
    this.hero = new SpriterObject(this, 400, 500, {
      key: "boy",
      entity: "Player",
      animation: "idle",
      loop: true,
      autoplay: true,
    });

    this.hero.play("walk", { loop: true });
  }
}

new Phaser.Game(config);

Documentation

• API (English)
• API (Русский)

Build

npm install
npm run build

Output:

• dist/index.js — ESM
• dist/index.cjs — CommonJS
• dist/index.d.ts — TypeScript types

Publish to npm

npm login
npm publish

License

MIT