@robotlegsjs/pixi NPM

RobotlegsJS PixiJS Extension

Integrate RobotlegsJS framework with PixiJS.

Installation

Get `@robotlegsjs/pixi`

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

npm install @robotlegsjs/pixi --save

Or using Yarn:

yarn add @robotlegsjs/pixi

From version 0.2.0 of this package, the PixiJS dependencies were moved to peerDependencies, allowing the final user to choose the desired version of the pixi.js library on each project.

For `pixi.js` version 6

The @robotlegsjs/pixi package version ^4.0.0 is compatible with versions >=6.0.0 <7 version range of pixi.js library.

You can setup your project for version 6 of pixi.js using:

npm install @robotlegsjs/pixi@^4.0.0 pixi.js@^6.0.0 --save

yarn add @robotlegsjs/pixi@^4.0.0 pixi.js@^6.0.0

For `pixi.js` version 5

The @robotlegsjs/pixi package versions ^2.0.0 and ^3.0.0 are compatible with versions >=5.0.0 <6 version range of pixi.js library.

Since version 5.0.0 of pixi.js, the eventemitter3 library was removed and is not necessary anymore.

You can setup your project for version 5 of pixi.js using:

npm install @robotlegsjs/pixi@^3.0.0 pixi.js@^5.0.0 --save

yarn add @robotlegsjs/pixi@^3.0.0 pixi.js@^5.0.0

For `pixi.js` version 4

For pixi.js >=4.2.1 <5, please use @robotlegsjs/pixi version ^1.

npm install @robotlegsjs/pixi@^1.0.1 --save

yarn add @robotlegsjs/pixi@^1.0.1

Since each version of pixi.js v4 library defines which version of eventemitter3 library is being used, remember to also install the proper version of eventemitter3 in your project.

As example, when you would like to use the version 4.2.1 of pixi.js library, you can run:

npm install pixi.js@4.2.1 eventemitter3@^2.0.0 reflect-metadata --save

yarn add pixi.js@4.2.1 eventemitter3@^2.0.0 reflect-metadata

Setup of your project

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

Dependencies

Peer Dependencies

Usage

import "reflect-metadata";

import { Context, MVCSBundle } from "@robotlegsjs/core";
import { ContextView, PixiBundle } from "@robotlegsjs/pixi";
import { AbstractRenderer, autoDetectRenderer, Container } from "pixi.js";
import { MyConfig } from "./config/MyConfig";
import { RobotlegsView } from "./view/RobotlegsView";

export class Game {
    private _canvas: HTMLCanvasElement;
    private _stage: Container;
    private _renderer: AbstractRenderer;
    private _context: Context;

    public constructor() {
        this._canvas = <HTMLCanvasElement>document.getElementById("canvas");
        this._renderer = autoDetectRenderer({
            width: 960,
            height: 400,
            view: this._canvas,
            backgroundColor: 0xffffff
        });
        this._stage = new Container();

        this._context = new Context();
        this._context
            .install(MVCSBundle, PixiBundle)
            .configure(new ContextView(this._stage))
            .configure(MyConfig)
            .initialize();

        this._stage.addChild(new RobotlegsView());

        document.body.appendChild(this._renderer.view);

        this.render();
    }

    public render = (): void => {
        this._renderer.render(this._stage);
        window.requestAnimationFrame(this.render);
    };
}

let game: Game = new Game();

See full example here

Running the example

Run the following commands to run the example:

npm start

or:

yarn start

RobotlegsJS PixiJS for enterprise

Available as part of the Tidelift Subscription

The maintainers of @robotlegsjs/pixi 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.