Skip to content

Commit

Permalink
chore: Update to new repo location
Browse files Browse the repository at this point in the history
  • Loading branch information
@bigtimebuddy
bigtimebuddy authored Dec 19, 2024
1 parent f9cdbac commit d34c887
Showing 1 changed file with 32 additions and 32 deletions.
64 changes: 32 additions & 32 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# PixiJS Particle Emitter

[![Build Status](https://github.com/pixijs/particle-emitter/workflows/Build/badge.svg)](https://github.com/pixijs/particle-emitter/actions?query=workflow%3A%22Build%22) [![GitHub version](https://badge.fury.io/gh/pixijs%2Fparticle-emitter.svg)](https://github.com/pixijs/particle-emitter/releases/latest)
[![Build Status](https://github.com/pixijs-userland/particle-emitter/workflows/Build/badge.svg)](https://github.com/pixijs-userland/particle-emitter/actions?query=workflow%3A%22Build%22) [![GitHub version](https://badge.fury.io/gh/pixijs-userland%2Fparticle-emitter.svg)](https://github.com/pixijs-userland/particle-emitter/releases/latest)

A particle system library for the [PixiJS](https://github.com/pixijs/pixi.js) library. Also, we created an [interactive particle editor](http://pixijs.github.io/pixi-particles-editor/) to design and preview custom particle emitters which utilitze PixiJS Particle Emitter. Note that the editor was built for an older version of the library - to use its output you'll have to use the [`upgradeConfig()`](https://pixijs.github.io/particle-emitter/docs/modules.html#upgradeConfig) function.
A particle system library for the [PixiJS](https://github.com/pixijs/pixijs) library. Also, we created an [interactive particle editor](https://userland.pixijs.io/particle-emitter-editor/) to design and preview custom particle emitters which utilitze PixiJS Particle Emitter. Note that the editor was built for an older version of the library - to use its output you'll have to use the [`upgradeConfig()`](https://userland.pixijs.io/particle-emitter/docs/modules.html#upgradeConfig) function.

## Breaking changes in v5 from v4
* Project has been renamed from `pixi-particles` to `@pixi/particle-emitter`
* On `Emitter`, configuration format has drastically changed. Use [`upgradeConfig()`](https://pixijs.github.io/particle-emitter/docs/modules.html#upgradeConfig) to convert old configuration objects automatically.
* On `Emitter`, configuration format has drastically changed. Use [`upgradeConfig()`](https://userland.pixijs.io/particle-emitter/docs/modules.html#upgradeConfig) to convert old configuration objects automatically.
* `PathParticle` and `AnimatedParticle` no longer exist, use the new behaviors instead.
* Dropped support for PixiJS v4. Please use v6 - while v5 may work, Typescript definitions won't work and will cause you a headache.
* The library now outputs ES6 code - if you need it in ES5 code, you'll need to make sure your build process transpiles it.
Expand Down Expand Up @@ -168,7 +168,7 @@ update();

## Documentation

http://pixijs.github.io/particle-emitter/docs/
https://userland.pixijs.io/particle-emitter/docs/

## Installation

Expand All @@ -180,34 +180,34 @@ npm install @pixi/particle-emitter

## Examples

* [Explosion 1](https://pixijs.github.io/particle-emitter/examples/explosion.html)
* [Explosion 2](https://pixijs.github.io/particle-emitter/examples/explosion2.html)
* [Explosion 3](https://pixijs.github.io/particle-emitter/examples/explosion3.html)
* [Explosion Ring](https://pixijs.github.io/particle-emitter/examples/explosionRing.html)
* [Megaman Death](https://pixijs.github.io/particle-emitter/examples/megamanDeath.html)
* [Rain](https://pixijs.github.io/particle-emitter/examples/rain.html)
* [Flame](https://pixijs.github.io/particle-emitter/examples/flame.html)
* [Flame on Polygonal Chain](https://pixijs.github.io/particle-emitter/examples/flamePolygonal.html)
* [Flame on Advanced Polygonal Chain](https://pixijs.github.io/particle-emitter/examples/flamePolygonalAdv.html)
* [Flame - Stepped Colors](https://pixijs.github.io/particle-emitter/examples/flameStepped.html)
* [Flame with Smoke](https://pixijs.github.io/particle-emitter/examples/flameAndSmoke.html)
* [Flame - Sputtering](https://pixijs.github.io/particle-emitter/examples/flameUneven.html)
* [Gas](https://pixijs.github.io/particle-emitter/examples/gas.html)
* [Bubbles](https://pixijs.github.io/particle-emitter/examples/bubbles.html)
* [Bubble Spray](https://pixijs.github.io/particle-emitter/examples/bubbleSpray.html)
* [Bubble Stream](https://pixijs.github.io/particle-emitter/examples/bubbleStream.html)
* [Bubble Stream - path following](https://pixijs.github.io/particle-emitter/examples/bubbleStreamPath.html)
* [Vertical Bubbles](https://pixijs.github.io/particle-emitter/examples/bubblesVertical.html)
* [Cartoon Smoke](https://pixijs.github.io/particle-emitter/examples/cartoonSmoke.html)
* [Cartoon Smoke Alt.](https://pixijs.github.io/particle-emitter/examples/cartoonSmoke2.html)
* [Cartoon Smoke Blast](https://pixijs.github.io/particle-emitter/examples/cartoonSmokeBlast.html)
* [Snow](https://pixijs.github.io/particle-emitter/examples/snow.html)
* [Sparks](https://pixijs.github.io/particle-emitter/examples/sparks.html)
* [Fountain](https://pixijs.github.io/particle-emitter/examples/fountain.html)
* [Animated Coins](https://pixijs.github.io/particle-emitter/examples/coins.html)
* [Animated Bubbles](https://pixijs.github.io/particle-emitter/examples/animatedBubbles.html)
* [Spaceship Destruction - Ordered Art](https://pixijs.github.io/particle-emitter/examples/spaceshipDestruction.html)
* [Particle Container Performance](https://pixijs.github.io/particle-emitter/examples/particleContainerPerformance.html)
* [Explosion 1](https://userland.pixijs.io/particle-emitter/examples/explosion.html)
* [Explosion 2](https://userland.pixijs.io/particle-emitter/examples/explosion2.html)
* [Explosion 3](https://userland.pixijs.io/particle-emitter/examples/explosion3.html)
* [Explosion Ring](https://userland.pixijs.io/particle-emitter/examples/explosionRing.html)
* [Megaman Death](https://userland.pixijs.io/particle-emitter/examples/megamanDeath.html)
* [Rain](https://userland.pixijs.io/particle-emitter/examples/rain.html)
* [Flame](https://userland.pixijs.io/particle-emitter/examples/flame.html)
* [Flame on Polygonal Chain](https://userland.pixijs.io/particle-emitter/examples/flamePolygonal.html)
* [Flame on Advanced Polygonal Chain](https://userland.pixijs.io/particle-emitter/examples/flamePolygonalAdv.html)
* [Flame - Stepped Colors](https://userland.pixijs.io/particle-emitter/examples/flameStepped.html)
* [Flame with Smoke](https://userland.pixijs.io/particle-emitter/examples/flameAndSmoke.html)
* [Flame - Sputtering](https://userland.pixijs.io/particle-emitter/examples/flameUneven.html)
* [Gas](https://userland.pixijs.io/particle-emitter/examples/gas.html)
* [Bubbles](https://userland.pixijs.io/particle-emitter/examples/bubbles.html)
* [Bubble Spray](https://userland.pixijs.io/particle-emitter/examples/bubbleSpray.html)
* [Bubble Stream](https://userland.pixijs.io/particle-emitter/examples/bubbleStream.html)
* [Bubble Stream - path following](https://userland.pixijs.io/particle-emitter/examples/bubbleStreamPath.html)
* [Vertical Bubbles](https://userland.pixijs.io/particle-emitter/examples/bubblesVertical.html)
* [Cartoon Smoke](https://userland.pixijs.io/particle-emitter/examples/cartoonSmoke.html)
* [Cartoon Smoke Alt.](https://userland.pixijs.io/particle-emitter/examples/cartoonSmoke2.html)
* [Cartoon Smoke Blast](https://userland.pixijs.io/particle-emitter/examples/cartoonSmokeBlast.html)
* [Snow](https://userland.pixijs.io/particle-emitter/examples/snow.html)
* [Sparks](https://userland.pixijs.io/particle-emitter/examples/sparks.html)
* [Fountain](https://userland.pixijs.io/particle-emitter/examples/fountain.html)
* [Animated Coins](https://userland.pixijs.io/particle-emitter/examples/coins.html)
* [Animated Bubbles](https://userland.pixijs.io/particle-emitter/examples/animatedBubbles.html)
* [Spaceship Destruction - Ordered Art](https://userland.pixijs.io/particle-emitter/examples/spaceshipDestruction.html)
* [Particle Container Performance](https://userland.pixijs.io/particle-emitter/examples/particleContainerPerformance.html)

## Contributer Note
This project uses `yarn` rather than `npm` to take advantage of the workspaces feature for the tests, making it easier to have standalone tests that share dependencies where possible.
Expand Down

0 comments on commit d34c887

Please sign in to comment.