Project Name Confusion - Githubissues

pixijs / particle-emitter

A particle system for PixiJS

http://pixijs.io/particle-emitter/docs

MIT License

796 stars 125 forks source link

Project Name Confusion #154

Closed bigtimebuddy closed 3 years ago

bigtimebuddy commented 3 years ago

This has been bothering me for awhile, there's some confusion between this library and the ParticleContainer package (@pixi/particles). I think we should disambiguate these two things more clearly by renaming one or both of these. "particles" is a little overloaded here.

Anyone have any ideas? I'm probably more inclined to change pixi-particles to something else as opposed to change ParticleContainer. Maybe @pixi/emitter or @pixi/particle-simulation?

andrewstart commented 3 years ago

I could live with @pixi/emitter, or @pixi/particle-emitter if you wanted to be explicit. That said, @pixi/particles probably causes its own confusion by only containing ParticleContainer with no way of actually generating particles.

bigtimebuddy commented 3 years ago

Good idea. I think this might be my preference:

Before	After
`@pixi/particles`	`@pixi/particle-container`
`pixi-particles`	`@pixi/particle-emitter`

There's a relationship, but they are still two separate things.

andrewstart commented 3 years ago

Yeah, that's probably the clearest naming convention.

bigtimebuddy commented 3 years ago

Couple of follow-up tasks related to this:

[x] Rename Readme from "Pixi Particles" to "PixiJS Particle Emitter"
[x] Rename repo from pixi-particles to particle-emitter
[x] Update Readme and repo links to reflect new gh-pages URL
[x] Rename the dist files and from pixi-particles to particle-emitter
[x] Fix links in docs/index.html
[x] Fix title in docs/examples/index.html
[x] Fix repo & bug links in package.json
[x] Publish latest version using @pixi scope

bigtimebuddy commented 3 years ago

:clap: