Archived

This repository is archived. Development migrated to https://github.com/RobotlegsJS/RobotlegsJS-Framework/blob/master/packages/phaser.

RobotlegsJS Phaser Extension

Integrate RobotlegsJS framework with Phaser.

Installation

You can get the latest release and the type definitions using NPM:

npm install @robotlegsjs/phaser --save-prod

Or using Yarn:

yarn add @robotlegsjs/phaser

From version 0.2.0 of this package, the Phaser dependency was moved to peerDependencies, allowing the final user to choose the desired version of the phaser library on each project.

The @robotlegsjs/phaser package version >=3.0.0 is compatible with versions between the >=3.22.0 <4 version range of phaser library.

As example, when you would like to use the version 3.22.0 of phaser library, you can run:

npm install phaser@3.22.0 reflect-metadata --save-prod

or

yarn add phaser@3.22.0 reflect-metadata

Then follow the installation instructions of RobotlegsJS library to complete the setup of your project.

Dependencies

• RobotlegsJS
• tslib

Peer Dependencies

• Phaser
• reflect-metadata

Usage

/// <reference path="../node_modules/phaser/types/phaser.d.ts" />

import "reflect-metadata";

import { Context, IContext, MVCSBundle } from "@robotlegsjs/core";

import { ContextSceneManager, PhaserBundle } from "@robotlegsjs/phaser";

import { GameConfig } from "./config/GameConfig";
import { SceneMediatorConfig } from "./config/SceneMediatorConfig";

import { SceneKey } from "./constants/SceneKey";

import { Boot } from "./scenes/Boot";
import { Main } from "./scenes/Main";
import { Preload } from "./scenes/Preload";

export class Game extends Phaser.Game {
    private _context: IContext;

    constructor() {
        super({
            type: Phaser.CANVAS,
            width: 800,
            height: 600,
            backgroundColor: "#010101",
            parent: "phaser-example"
        });

        this._context = new Context();
        this._context
            .install(MVCSBundle, PhaserBundle)
            .configure(new ContextSceneManager(this.scene))
            .configure(SceneMediatorConfig)
            .configure(GameConfig)
            .initialize();

        this.scene.add(SceneKey.BOOT, new Boot());
        this.scene.add(SceneKey.PRELOAD, new Preload());
        this.scene.add(SceneKey.MAIN, new Main());

        this.scene.start(SceneKey.BOOT);
    }
}

See example

Running the example

Run the following commands to run the example:

npm install
npm start

or:

yarn install
yarn start

Checking the example

You can check our example project here.

RobotlegsJS integration with Phaser CE (Community Edition)

The @robotlegsjs/phaser package was updated to support Phaser v3 plugin.

If you are looking for integration with Phaser CE you can use the RobotlegsJS-Phaser-CE plugin.

RobotlegsJS Phaser for enterprise

Available as part of the Tidelift Subscription

The maintainers of @robotlegsjs/phaser and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

License

MIT