{ "name": "@robotlegsjs/pixi", "version": "4.0.0", "description": "PIXI View Integration with RobotlegsJS", "main": "lib/index.js", "typings": "lib/index.d.ts", "repository": { "url": "https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/pixi" }, "publishConfig": { "registry": "https://registry.npmjs.org" }, "keywords": [ "TypeScript", "Robotlegs", "IoC", "PIXI" ], "author": "RobotlegsJS", "contributors": [ "Bùi Việt Thành ", "Endel Dreyer ", "Mateusz Szymik ", "Tiago Schenkel " ], "license": "MIT", "bugs": { "url": "https://github.com/RobotlegsJS/RobotlegsJS-Framework/issues" }, "homepage": "https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/pixi#readme", "files": [ "definitions", "lib" ], "directories": { "lib": "./lib" }, "dependencies": { "@robotlegsjs/core": "^3.1.0", "@robotlegsjs/eventemitter3": "^3.1.0", "tslib": "^2.3.0" }, "peerDependencies": { "pixi.js": "^6.0.0", "reflect-metadata": "^0.1.13" }, "devDependencies": { "@jsdevtools/coverage-istanbul-loader": "^3.0.5", "@pixi/constants": "^6.3.2", "@pixi/core": "^6.3.2", "@pixi/display": "^6.3.2", "@pixi/math": "^6.3.2", "@pixi/runner": "^6.3.2", "@pixi/settings": "^6.3.2", "@pixi/ticker": "^6.3.2", "@pixi/utils": "^6.3.2", "@rushstack/eslint-config": "^2.3.4", "@types/bluebird": "^3.5.36", "@types/chai": "^4.2.21", "@types/mocha": "^8.2.3", "@types/sinon": "^10.0.2", "@types/webpack-env": "^1.16.2", "bluebird": "^3.7.2", "chai": "^4.3.4", "clean-webpack-plugin": "^3.0.0", "copy-webpack-plugin": "^9.0.1", "es6-map": "^0.1.5", "es6-symbol": "^3.1.3", "eslint": "^7.30.0", "eslint-plugin-import": "^2.23.4", "eslint-plugin-jsdoc": "^35.4.3", "eslint-plugin-prefer-arrow": "^1.2.3", "eslint-plugin-react": "^7.24.0", "eslint-plugin-unicorn": "^34.0.1", "html-webpack-plugin": "^5.3.2", "karma": "^6.3.4", "karma-chrome-launcher": "^3.1.0", "karma-coverage-istanbul-reporter": "^3.0.3", "karma-mocha": "^2.0.1", "karma-mocha-reporter": "^2.2.5", "karma-sinon-chai": "^2.0.2", "karma-sourcemap-loader": "^0.3.8", "karma-sourcemap-writer": "^0.1.2", "karma-webpack": "^5.0.0", "mocha": "^9.0.2", "pixi.js": "^6.3.2", "prettier": "^2.6.2", "puppeteer": "^10.1.0", "reflect-metadata": "^0.1.13", "rimraf": "^3.0.2", "sinon": "^11.1.1", "sinon-chai": "^3.7.0", "terser-webpack-plugin": "^5.1.4", "ts-loader": "^9.2.3", "ts-node": "^10.1.0", "typescript": "~4.2.4", "webpack": "^5.44.0", "webpack-cli": "^4.7.2", "webpack-dev-server": "^3.11.2" }, "scripts": { "start": "webpack serve --config ./webpack.example.config.js", "test": "node --max-old-space-size=2048 ./node_modules/karma/bin/karma start --single-run", "autoformat": "prettier --config ../../.prettierrc --ignore-path ../../.prettierignore --write --list-different .", "lint-fix:src": "eslint -c .eslintrc.js --ext .ts ./src --fix", "lint-fix:test": "eslint -c .eslintrc.js --ext .ts ./test --fix", "lint-fix:example": "eslint -c .eslintrc.js --ext .ts ./example --fix", "lint-fix": "npm run lint-fix:src && npm run lint-fix:test && npm run lint-fix:example", "lint:src": "eslint -c .eslintrc.js --ext .ts ./src", "lint:test": "eslint -c .eslintrc.js --ext .ts ./test", "lint:example": "eslint -c .eslintrc.js --ext .ts ./example", "lint": "npm run lint:src && npm run lint:test && npm run lint:example", "cleanup": "rimraf .nyc_output && rimraf coverage && rimraf lib && rimraf lib-test && rimraf lib-example && rimraf dist && rimraf dist-test", "compile:src": "tsc", "compile:test": "tsc -p tsconfig.test.json", "compile:example": "tsc -p tsconfig.example.json", "dist:dev": "webpack", "dist:production": "webpack --env production", "build:example": "webpack --config ./webpack.example.config.js --env.production", "deploy:example": "./deploy-example.sh", "build": "npm run cleanup && npm run compile:src" }, "readme": "# RobotlegsJS PixiJS Extension\n\n[![GitHub license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/pixi/LICENSE)\n[![Gitter chat](https://badges.gitter.im/RobotlegsJS/RobotlegsJS.svg)](https://gitter.im/RobotlegsJS/RobotlegsJS)\n[![npm version](https://badge.fury.io/js/%40robotlegsjs%2Fpixi.svg)](https://badge.fury.io/js/%40robotlegsjs%2Fpixi)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n\nIntegrate [RobotlegsJS](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/core)\nframework with [PixiJS](https://github.com/pixijs/pixi.js).\n\n## Installation\n\n### Get `@robotlegsjs/pixi`\n\nYou can get the latest release and the type definitions using [NPM](https://www.npmjs.com/):\n\n```bash\nnpm install @robotlegsjs/pixi --save\n```\n\nOr using [Yarn](https://yarnpkg.com/en/):\n\n```bash\nyarn add @robotlegsjs/pixi\n```\n\nFrom version `0.2.0` of this package, the [PixiJS](https://github.com/pixijs/pixi.js) dependencies were moved to **peerDependencies**,\nallowing the final user to choose the desired version of the `pixi.js` library on each project.\n\n#### For `pixi.js` version 6\n\nThe `@robotlegsjs/pixi` package version `^4.0.0` is compatible with versions `>=6.0.0 <7` version range of `pixi.js` library.\n\nYou can setup your project for version 6 of `pixi.js` using:\n\n```bash\nnpm install @robotlegsjs/pixi@^4.0.0 pixi.js@^6.0.0 --save\n```\n\nor\n\n```bash\nyarn add @robotlegsjs/pixi@^4.0.0 pixi.js@^6.0.0\n```\n\n#### For `pixi.js` version 5\n\nThe `@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.\n\nSince version `5.0.0` of `pixi.js`, the `eventemitter3` library was removed and is not necessary anymore.\n\nYou can setup your project for version 5 of `pixi.js` using:\n\n```bash\nnpm install @robotlegsjs/pixi@^3.0.0 pixi.js@^5.0.0 --save\n```\n\nor\n\n```bash\nyarn add @robotlegsjs/pixi@^3.0.0 pixi.js@^5.0.0\n```\n\n#### For `pixi.js` version 4\n\nFor `pixi.js` `>=4.2.1 <5`, please use `@robotlegsjs/pixi` version `^1`.\n\n```bash\nnpm install @robotlegsjs/pixi@^1.0.1 --save\n```\n\nor\n\n```bash\nyarn add @robotlegsjs/pixi@^1.0.1\n```\n\nSince 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.\n\nAs example, when you would like to use the version `4.2.1` of `pixi.js` library, you can run:\n\n```bash\nnpm install pixi.js@4.2.1 eventemitter3@^2.0.0 reflect-metadata --save\n```\n\nor\n\n```bash\nyarn add pixi.js@4.2.1 eventemitter3@^2.0.0 reflect-metadata\n```\n\n### Setup of your project\n\nThen follow the [installation instructions](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/core#installation) of **RobotlegsJS** library to complete the setup of your project.\n\n**Dependencies**\n\n+ [RobotlegsJS](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/core)\n+ [RobotlegsJS-EventEmitter3](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/eventemitter3)\n+ [tslib](https://github.com/Microsoft/tslib)\n\n**Peer Dependencies**\n\n+ [PixiJS](https://github.com/pixijs/pixi.js)\n+ [reflect-metadata](https://github.com/rbuckton/reflect-metadata)\n\n## Usage\n\n```typescript\nimport \"reflect-metadata\";\n\nimport { Context, MVCSBundle } from \"@robotlegsjs/core\";\nimport { ContextView, PixiBundle } from \"@robotlegsjs/pixi\";\nimport { AbstractRenderer, autoDetectRenderer, Container } from \"pixi.js\";\nimport { MyConfig } from \"./config/MyConfig\";\nimport { RobotlegsView } from \"./view/RobotlegsView\";\n\nexport class Game {\n private _canvas: HTMLCanvasElement;\n private _stage: Container;\n private _renderer: AbstractRenderer;\n private _context: Context;\n\n public constructor() {\n this._canvas = document.getElementById(\"canvas\");\n this._renderer = autoDetectRenderer({\n width: 960,\n height: 400,\n view: this._canvas,\n backgroundColor: 0xffffff\n });\n this._stage = new Container();\n\n this._context = new Context();\n this._context\n .install(MVCSBundle, PixiBundle)\n .configure(new ContextView(this._stage))\n .configure(MyConfig)\n .initialize();\n\n this._stage.addChild(new RobotlegsView());\n\n document.body.appendChild(this._renderer.view);\n\n this.render();\n }\n\n public render = (): void => {\n this._renderer.render(this._stage);\n window.requestAnimationFrame(this.render);\n };\n}\n\nlet game: Game = new Game();\n\n```\n\n[See full example here](example/index.ts)\n\n## Running the example\n\nRun the following commands to run the example:\n\n```bash\nnpm start\n```\n\nor:\n\n```bash\nyarn start\n```\n\n## RobotlegsJS PixiJS for enterprise\n\nAvailable as part of the Tidelift Subscription\n\nThe maintainers of [@robotlegsjs/pixi](https://github.com/RobotlegsJS/RobotlegsJS-Framework/tree/master/packages/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.](https://tidelift.com/subscription/pkg/npm-robotlegsjs-pixi?utm_source=npm-robotlegsjs-pixi&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)\n\n## License\n\n[MIT](LICENSE)\n" }