yordan-kanchelov/pixi-console

Pixi.js console

Pixi-console

Console class for PIXI useful for developing mobile game.

By default attaches itself to console log and error and will show itself if error is occurred.

Table of Contents

• Pixi-console
  • Table of Contents
  • Installation
  • Usage
  • Documentation
  • Support
  • Contributing

Installation

npm install pixi-console

• If you want > pixi.js 5.0.0 support go with pixi-console 3.0.0 or greater version
• For backward compatibility ( pixi.js v4.0.0 ) go with pixi-console 2.5.0 or greater version

Usage

import { PixiConsole, PixiConsoleConfig } from "pixi-console";

// customize default values of PixiConsole
const consoleConfig = new PixiConsoleConfig();
consoleConfig.consoleWidth = 800;
consoleConfig.consoleHeight = 600;

const pixiConsole = new PixiConsole(consoleConfig);
stage.addChild(pixiConsole);

const secondConsole = new PixiConsole(consoleConfig); // Error PixiConsole is singleton..
pixiConsole == PixiConsole.getInstance(); // true

Documentation

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.