Pixi Seed

This project is designed to bootstrap your Pixi.js development with modern tooling, technology and project organisation. Use as boilerplate for your next project.

Webpack with ES6 provides a more class based approach to Pixi.js development and allows you to include assets within your JS. Reactman enables you to quickly add code to your project and the using Stores helps organise your data.

The project comes with Render and Animation stores and a ScaledContainer to help work across multiple devices with a ‘best-fit’ rendering methodology.

Example Display Object

Here's the PIXI.js bunny expressed as an interactive sprite in ES6.

import { Tween } from 'tween.js';
import { Sprite, Texture } from 'pixi.js';
import BUNNY from './bunny.png';

/**
 * A bunny which spins on it's feet when moused over
 *
 * @exports Bunny
 * @extends Sprite
 */
export default class Bunny extends Sprite {

  constructor() {
    const texture = Texture.fromImage(BUNNY);

    super(texture);

    this.tween = new Tween(this);

    this.anchor.x = .5;
    this.anchor.y = 1;

    this.pivot.x = .5;
    this.pivot.y = .5;

    this.interactive = true;
  }

  startSpin() {
    this.tween.to({rotation: Math.PI*2}, 1000);
    this.tween.start();
    this.tween.onComplete(() => this.rotation = 0);
  }

  mouseover() {
    this.startSpin();
  }

}

Getting started

Clone the project and remove the git repository:

git clone --depth=1 https://github.com/edwinwebb/pixi-seed.git my-project
cd my-project
rm -rf .git

You can configure some app settings in package.json

"config": {
  "buildDir": "./build",
  "stageWidth": 1920,
  "stageHeight": 1080
}

npm scripts

npm start - Build and start the app in development mode at http://localhost:8080
npm run build - Run a production build, outputs to ./build/
npm run lint - Lint your code
npm run reactman - Generate code for a DisplayObject or Store

Static assets

import asset files from within your JavaScript component files. To add more filetypes, look at the webpack.config.js and add a file loader.

// Filename: app.js
import assetURL from './logo.png';

Removing the bootstrapped files

It's as easy as removing all the child folders in ./app/ then emptying app.js.

License

MIT (http://opensource.org/licenses/MIT)

matyunya / zhabamarket