Nomenclature Processing Machine

npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript.Learn more »

@robotlegsjs/phaser

1.0.1 • Public • Published

RobotlegsJS Phaser Extension

GitHub license Gitter chat Build Status codebeat badge Maintainability Test Coverage npm version Greenkeeper badge styled with prettier

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 is compatible with versions between the >=3.11.0 <4 version range of phaser library.

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

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

or

yarn add phaser@3.11.0 reflect-metadata

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

Dependencies

Peer Dependencies

Usage

/// <reference path="../node_modules/@robotlegsjs/phaser/definitions/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

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.

License

MIT

install

npm i @robotlegsjs/phaser

Downloadsweekly downloads

21

version

1.0.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
Report a vulnerability