README.md

Archived

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

RobotlegsJS OpenFL Extension

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 [email protected] reflect-metadata --save

or

yarn add [email protected] reflect-metadata

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

Dependencies

• RobotlegsJS
• tslib

Peer Dependencies

• OpenFL
• reflect-metadata

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

Checking the example

You can check our example project here.

RobotlegsJS OpenFL for enterprise

Available as part of the Tidelift Subscription

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