Repository files navigation

The aim of this project is to provide a fast lightweight 2D library that worksacross all devices. The PixiJS renderer allows everyone to enjoy the power ofhardware 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(@doormat23,@rolnaaba,@bigtimebuddy,@ivanpopelyshev)and we will keep you posted! You can also check back onour siteas any breakthroughs will be posted up there too!

Your support helps us make PixiJS even better. Make your pledge onPatreon and we'll love you forever!

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 fullWebGL support and seamlessly falls back to HTML5'scanvas 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!

• Website: Find out more about PixiJS on theoffical website.
• Getting started: Check out @kittykatattack's comprehensivetutorial.
• Examples: Get stuck right in and play around with PixiJS code and features righthere!
• Docs: Get to know the PixiJS API by checking out thedocs.
• Wiki: Other misc tutorials and resources areon the Wiki.

• Forums: Check out theforum andStackoverflow, both friendly places to ask your pixi questions.
• Inspiration: Check out thegallery to see some of the amazing things people have created!
• Chat: You can join us onGitter To chat about PixiJS. We also now have a Slack channel. If you would like to join it please Send me an email (mat@goodboydigital.com) and I will invite you in.

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

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

Note: After v4.5.0, support for theBower package manager has been dropped. Please see therelease notes for more information.

$> npm install pixi.js

<scriptsrc="https://cdnjs.cloudflare.com/ajax/libs/pixi.js/4.5.1/pixi.min.js"></script>

Note:4.5.1 can be replaced by anyreleased version.

• Filters Demo
• Run Pixie Run
• Fight for Everyone
• 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 providingthose last 2 examples and allowing us to share the source code :)

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

Make sure to read theContributing Guidebefore submitting changes.

• 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

// The application will create a renderer using WebGL, if possible,// with a fallback to a canvas render. It will also setup the ticker// and the root stage PIXI.Containerconstapp=newPIXI.Application();// The application will create a canvas element for you that you// can then insert into the DOMdocument.body.appendChild(app.view);// load the texture we needPIXI.loader.add('bunny','bunny.png').load((loader,resources)=>{// This creates a texture from a 'bunny.png' imageconstbunny=newPIXI.Sprite(resources.bunny.texture);// Setup the position of the bunnybunny.x=app.renderer.width/2;bunny.y=app.renderer.height/2;// Rotate around the centerbunny.anchor.x=0.5;bunny.anchor.y=0.5;// Add the bunny to the scene we are buildingapp.stage.addChild(bunny);// Listen for frame updatesapp.ticker.add(()=>{// each frame we spin the bunny around a bitbunny.rotation+=0.01;});});

Note that for most users you don't need to build this project. If all you want is to use PixiJS, thenjust download one of ourprebuilt releases. Reallythe 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 clonedthe repository, install the build dependencies using npm:

$> npm install

Then, to build the source, run:

$> npm run dist

This will create a minified version atdist/pixi.min.js and a non-minified version atdist/pixi.jswith all the plugins in the PixiJS project.

If there are specific plugins you don't want, say "interaction" or "extras", you can exclude those:

$> npm run dist -- --exclude extras --exclude interaction

You can also use the short-form-e:

$> npm run dist -- -e extras -e interaction -e filters

The docs can be generated using npm:

$> npm run docs

The documentation usesJaguar.js and the jsdoc format, the configuration file can be found atscripts/jsdoc.conf.json

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