Pixi.js

The HTML5 Creation Engine: Create beautiful digital content with the fastes...

Game engine
pixijs/pixijspixijs.compixi.js

README

PixiJS — The HTML5 Creation Engine
=============

pixi.js logo
Discord npm version Node.js CI

This project aims to provide a fast lightweight 2D library that works
across all devices. The PixiJS renderer allows everyone to enjoy the power of
hardware acceleration without prior knowledge of WebGL. Also, it's fast. Really fast.

If you want to keep up to date with the latest PixiJS news then feel free to follow us on Twitter @PixiJS
and we will keep you posted! You can also check back on our site
as any breakthroughs will be posted up there too!

We are now a part of the Open Collective and with your support you can help us make PixiJS even better. To make a donation, simply click the button below and we'll love you forever!


What to Use PixiJS for and When to Use It


PixiJS is a rendering library that will allow you to create rich, interactive graphics, cross-platform applications, and games without having to dive into the WebGL API or deal with browser and device compatibility.

PixiJS has full WebGL support and seamlessly falls back to HTML5's canvas if needed. As a framework, PixiJS is a fantastic tool for authoring interactive content,especially with the move away from Adobe Flash in recent years. Use it for your graphics-rich, interactive websites, applications, and HTML5 games.  Out of the box, cross-platform compatibility and graceful degradation mean you have less work to do and have more fun doing it! If you want to create polished and refined experiences relatively quickly, without delving into dense, low-level code, all while avoiding the headaches of browser inconsistencies, then sprinkle your next project with some PixiJS magic!

Boost your development and feel free to use your imagination!

Learn ###

- Website: Find out more about PixiJS on the official website.
- Getting started:
    - Check out @kittykatattack's comprehensive tutorial.
    - Also check out @miltoncandelero's PixiJS tutorials aimed toward videogames with recipes, best practices and TypeScript / npm / webpack setup here
- Examples: Get stuck right in and play around with PixiJS code and features right here!
- Docs: Get to know the PixiJS API by checking out the docs.
- Guide: Supplementary guide to the API documentation here.
- Wiki: Other misc tutorials and resources are on the Wiki.

Community ###

- Forums: Check out the forum and Stackoverflow, both friendly places to ask your PixiJS questions.
- Inspiration: Check out the gallery to see some of the amazing things people have created!
- Chat: You can join us on Discord to chat about PixiJS.

Setup ###


It's easy to get started with PixiJS! Simply download a prebuilt build!

Alternatively, PixiJS can be installed with npm or simply using a content delivery network (CDN) URL to embed PixiJS directly on your HTML page.

_Note: After v4.5.0, support for the Bower package manager has been dropped. Please see the release notes for more information._

NPM Install


  1. ```sh
  2. npm install pixi.js
  3. ```

There is no default export. The correct way to import PixiJS is:

  1. ``` js
  2. import * as PIXI from 'pixi.js'
  3. ```

CDN Install


Via jsDelivr:

  1. ``` html
  2. <script src="https://cdn.jsdelivr.net/npm/pixi.js@7.x/dist/browser/pixi.min.js"></script>
  3. ```

Or via unpkg:

  1. ``` html
  2. <script src="https://unpkg.com/pixi.js@7.x/dist/browser/pixi.min.js"></script>
  3. ```

Demos ###


- Filters Demo
- Run Pixie Run
- Flash vs HTML
- Bunny Demo
- Storm Brewing
- Render Texture Demo
- Primitives Demo
- Masking Demo
- Interaction Demo
- photonstorm's Balls Demo
- photonstorm's Morph Demo

Thanks to @photonstorm for providing
those last 2 examples and allowing us to share the source code :)

Contribute ###


Want to be part of the PixiJS project? Great! All are welcome! We will get there quicker
together :) Whether you find a bug, have a great feature request or you fancy owning a task
from the road map above feel free to get in touch.

Make sure to read the Contributing Guide
before submitting changes.

Current features ###


- WebGL renderer (with automatic smart batching allowing for REALLY fast performance)
- Canvas renderer (Fastest in town!)
- Full scene graph
- Super easy to use API (similar to the flash display list API)
- Support for texture atlases
- Asset loader / sprite sheet loader
- Auto-detect which renderer should be used
- Full Mouse and Multi-touch Interaction
- Text
- BitmapFont text
- Multiline Text
- Render Texture
- Primitive Drawing
- Masking
- Filters
- User Plugins

Basic Usage Example ###


  1. ``` js
  2. import { Application, Sprite, Assets } from 'pixi.js';

  4. // The application will create a renderer using WebGL, if possible,
  5. // with a fallback to a canvas render. It will also setup the ticker
  6. // and the root stage PIXI.Container
  7. const app = new Application();

  9. // The application will create a canvas element for you that you
  10. // can then insert into the DOM
  11. document.body.appendChild(app.view);

  13. // load the texture we need
  14. const texture = await Assets.load('bunny.png');

  16. // This creates a texture from a 'bunny.png' image
  17. const bunny = new Sprite(texture);

  19. // Setup the position of the bunny
  20. bunny.x = app.renderer.width / 2;
  21. bunny.y = app.renderer.height / 2;

  23. // Rotate around the center
  24. bunny.anchor.x = 0.5;
  25. bunny.anchor.y = 0.5;

  27. // Add the bunny to the scene we are building
  28. app.stage.addChild(bunny);

  30. // Listen for frame updates
  31. app.ticker.add(() => {
  32.     // each frame we spin the bunny around a bit
  33.     bunny.rotation += 0.01;
  34. });
  35. ```

How to build ###


Note that for most users you don't need to build this project. If all you want is to use PixiJS, then
just download one of our prebuilt releases.
The only time you should need to build PixiJS is if you are developing it.

If you don't already have Node.js and NPM, go install them. Then, in the folder where you have cloned
the repository, install the build dependencies using npm:

  1. ```sh
  2. npm install
  3. ```

Then, to build the source, run:

  1. ```sh
  2. npm run build
  3. ```

Error installing gl package


In most cases installing gl from npm should just work. However, if you run into problems you might need to adjust your system configuration and make sure all your dependencies are up to date

Please refer to the gl installation guide for more information.

Error installing canvas package


The canvas library currently being used does not have a pre-built version for every environment.
When the package detects an unsupported environment, it will try to build from source.

To build from source you will need to make sure you have the following dependencies installed and then reinstall:

brew install pkg-config cairo pango libpng jpeg giflib librsvg

For non-mac users, please refer to the canvas installation guide for more information.

How to generate the documentation ###


The docs can be generated using npm:

  1. ```sh
  2. npm run docs
  3. ```

The documentation uses webdoc in combination with this template pixi-webdoc-template. The configuration file can be found at webdoc.conf.json

License ###


This content is released under the (http://opensource.org/licenses/MIT) MIT License.