npm

Need private packages and team management tools?Check out npm Orgs. »

@robotlegsjs/openfl

1.0.0 • Public • Published

RobotlegsJS OpenFL Extension

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

Integrate RobotlegsJS framework with OpenFL.

Installation

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

npm install @robotlegsjs/openfl --save

Or using Yarn:

yarn add @robotlegsjs/openfl

The OpenFL dependency is added as peerDependencies, allowing the final user to choose the desired version of the openfl library on each project.

The @robotlegsjs/openfl package is compatible with versions between the >=8.3.0 version range of openfl library.

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

npm install openfl@8.3.0 reflect-metadata --save

or

yarn add openfl@8.3.0 reflect-metadata

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, OpenFLBundle } from "@robotlegsjs/openfl";
 
import { MyConfig } from "./config/MyConfig";
 
import { GameView } from "./view/GameView";
 
import Stage from "openfl/display/Stage";
 
export class Game {
    private _loading: HTMLDivElement;
    private _canvas: HTMLDivElement;
 
    private _stage: Stage;
 
    private _context: Context;
 
    constructor() {
        this.init();
    }
 
    private init(): void {
        // remove loader
        this._loading = <HTMLDivElement>(document.getElementById("loading"));
        document.body.removeChild(this._loading);
 
        // create stage
        this._stage = new Stage(960, 400, 0xffffff, GameView);
 
        // create robotlegs context
        this._context = new Context();
        this._context.install(MVCSBundle, OpenFLBundle).
            configure(new ContextView(this._stage)).
            configure(MyConfig).
            initialize();
 
        // add stage to html body
        this._canvas = <HTMLDivElement>(document.getElementById("canvas"));
        this._canvas.appendChild(this._stage.element);
    }
}

See full example here

Running the example

Run the following commands to run the example:

npm install
npm start

or:

yarn install
yarn start

License

MIT

install

npm i @robotlegsjs/openfl

Downloadsweekly downloads

0

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
Report a vulnerability