https://github.com/RobotlegsJS/RobotlegsJS-Phaser
RobotlegsJS framework integration with Phaser
https://github.com/RobotlegsJS/RobotlegsJS-Phaser
phaser robotlegsjs
Last synced: 7 months ago
JSON representation
RobotlegsJS framework integration with Phaser
- Host: GitHub
- URL: https://github.com/RobotlegsJS/RobotlegsJS-Phaser
- Owner: RobotlegsJS
- License: mit
- Created: 2017-08-02T14:10:14.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T16:59:36.000Z (over 3 years ago)
- Last Synced: 2024-05-17T12:33:18.497Z (about 2 years ago)
- Topics: phaser, robotlegsjs
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@robotlegsjs/phaser
- Size: 4.21 MB
- Stars: 21
- Watchers: 6
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-phaser - RobotlegsJS - RobotlegsJS framework integration with Phaser. (Uncategorized / Uncategorized)
README
# Archived
**This repository is archived**. Development migrated to https://github.com/RobotlegsJS/RobotlegsJS-Framework/blob/master/packages/phaser.
# RobotlegsJS Phaser Extension
[](https://github.com/RobotlegsJS/RobotlegsJS-Phaser/blob/master/LICENSE)
[](https://gitter.im/RobotlegsJS/RobotlegsJS)
[](https://badge.fury.io/js/%40robotlegsjs%2Fphaser)
[](https://github.com/prettier/prettier)
Integrate [RobotlegsJS](https://github.com/RobotlegsJS/RobotlegsJS)
framework with [Phaser](https://github.com/photonstorm/phaser).
## Installation
You can get the latest release and the type definitions using [NPM](https://www.npmjs.com/):
```bash
npm install @robotlegsjs/phaser --save-prod
```
Or using [Yarn](https://yarnpkg.com/en/):
```bash
yarn add @robotlegsjs/phaser
```
From version `0.2.0` of this package, the [Phaser](https://github.com/photonstorm/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:
```bash
npm install phaser@3.22.0 reflect-metadata --save-prod
```
or
```bash
yarn add phaser@3.22.0 reflect-metadata
```
Then follow the [installation instructions](https://github.com/RobotlegsJS/RobotlegsJS/blob/master/README.md#installation) of **RobotlegsJS** library to complete the setup of your project.
**Dependencies**
+ [RobotlegsJS](https://github.com/RobotlegsJS/RobotlegsJS)
+ [tslib](https://github.com/Microsoft/tslib)
**Peer Dependencies**
+ [Phaser](https://github.com/photonstorm/phaser)
+ [reflect-metadata](https://github.com/rbuckton/reflect-metadata)
## Usage
```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](example)
## Running the example
Run the following commands to run the example:
```bash
npm install
npm start
```
or:
```bash
yarn install
yarn start
```
## Checking the example
You can check our example project [here](http://robotlegsjs.io/RobotlegsJS-Phaser).
## RobotlegsJS integration with Phaser CE (Community Edition)
The `@robotlegsjs/phaser` package was updated to support [Phaser v3](https://www.npmjs.com/package/phaser) plugin.
If you are looking for integration with [Phaser CE](https://github.com/photonstorm/phaser-ce) you can use the [RobotlegsJS-Phaser-CE](https://github.com/RobotlegsJS/RobotlegsJS-Phaser-CE) plugin.
## RobotlegsJS Phaser for enterprise
Available as part of the Tidelift Subscription
The maintainers of [@robotlegsjs/phaser](https://github.com/RobotlegsJS/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.](https://tidelift.com/subscription/pkg/npm-robotlegsjs-phaser?utm_source=npm-robotlegsjs-phaser&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
## License
[MIT](LICENSE)