{"_id":"@c-frame/aframe-particle-system-component","_rev":"2-25beb57f0f3e835fa4b2d9dcf30efb72","name":"@c-frame/aframe-particle-system-component","dist-tags":{"latest":"1.2.0"},"versions":{"1.1.4":{"name":"@c-frame/aframe-particle-system-component","version":"1.1.4","keywords":["ideaspace","c-frame","webvr","aframe-vr","aframe-component","aframe","mozvr","vr"],"author":{"url":"https://www.IdeaSpace.org","name":"IdeaSpace","email":"info@IdeaSpace.org"},"license":"MIT","_id":"@c-frame/aframe-particle-system-component@1.1.4","maintainers":[{"name":"diarmidmackenzie","email":"diarmid.mackenzie@gmail.com"},{"name":"vincentfretin","email":"vincent.fretin@gmail.com"},{"name":"finetype","email":"finesttype@gmail.com"}],"homepage":"https://github.com/c-frame/aframe-particle-system-component#readme","bugs":{"url":"https://github.com/c-frame/aframe-particle-system-component/issues"},"dist":{"shasum":"fac9bb5f38f9ddb87b0bc345758c3c958e1512c7","tarball":"https://registry.npmjs.org/@c-frame/aframe-particle-system-component/-/aframe-particle-system-component-1.1.4.tgz","fileCount":21,"integrity":"sha512-I5+DnxrJYUpvvDFGYkkkqmbgl0h65TziJygL68GR9FItUby3cWKlfzQk+4nwx866fXcOyxzDomEYIammr+hlgA==","signatures":[{"sig":"MEUCIQD30AU3HGzBHx9m26EgFeblu49PzX1x5h+lSUvNr6bLUwIgdcxCmyHRGSVDbj1BSTFQE736MNMuvVLHSP7NeAKWAJ4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":621671,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjv8yxACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq/Vg/+M5Ea/Bz9tIUzASCNkyHXvHbjEwO4Q1lTdmY7LUlpP4MgUZ/a\r\nt4mKx736KQK4dgyovyEWZq/nuEX2zamCeoa+tBi23ACTWwoJDSabBv33vzqp\r\nmjho28cZGoJFjZjor3GFTo1SV2WIO3Zupb8w+Al0U8NemfN6Jm8LAse0Dhmj\r\nRnh+pHZgrs3WdyvJwQJ6eDVPrNTjlY3ourJNe7aOQ7vSTIFPyGBKejoV5Z8k\r\n7s+mrZd20cacgUuokxOMBJeMjIIRiFKKOPwM7laGzRtuVSDyb6oI4ZuPt52O\r\nrsqmZ8WUuMmkfaR43zfeyj6H0KkXYwv03nH5XOYTSOlK+7VRpqce0eRLSOvp\r\nGIaJZr9t6KLGLeawc0QvE7PmIs55fJt5yYTE5kcg0fMcZusBTwEl3BgcWozK\r\nLS3raOU6IbHZyfHDvVFnATwMyB8ClgfOvJ78bOOy/mg0thl3IG/NO8Mtm5cT\r\nE5rP6qrdxnDOoft19hJbQ2NNHpsDw/z9tIFKEavU/v8YnSy6ZbsnEdFFrF1O\r\nDxZgx46o9jWHB+QdwjBPjjYXyDlAiRw735sJ84KlEs3jpS1qUPoj8eCffmig\r\nj0QOkd8qa07bVpYpQZLYj1HQrDA/XfUbO21mAP1El40tXxxDwlXscUK+H/86\r\na8bLdlC3JfYDXfETqZu7pjVqE7K29kLSNFU=\r\n=LK0c\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","gitHead":"c6e9390ec3f39fb933c32ff2883985c301d399a7","scripts":{"dev":"budo index.js:../../dist/aframe-particle-system-component.min.js --port 8000 --live --open","dist":"webpack index.js dist/aframe-particle-system-component.js && webpack -p index.js dist/aframe-particle-system-component.min.js","lint":"semistandard -v | snazzy","start":"npm run dev","ghpages":"npm run preghpages && ghpages -p gh-pages","preghpages":"npm run build && shx rm -rf gh-pages && shx mkdir gh-pages && shx cp -r examples/* gh-pages","prepublish":"npm run dist"},"_npmUser":{"name":"diarmidmackenzie","email":"diarmid.mackenzie@gmail.com"},"repository":{"url":"git+https://github.com/c-frame/aframe-particle-system-component.git","type":"git"},"_npmVersion":"8.15.0","description":"Particle systems for A-Frame.","directories":{"example":"examples"},"_nodeVersion":"16.17.0","_hasShrinkwrap":false,"devDependencies":{"shx":"^0.1.1","budo":"^8.2.2","snazzy":"^4.0.0","shelljs":"^0.7.0","webpack":"^1.13.0","browserify":"^13.0.0","randomcolor":"^0.4.4","semistandard":"^8.0.0","browserify-css":"^0.9.1"},"_npmOperationalInternal":{"tmp":"tmp/aframe-particle-system-component_1.1.4_1673514161605_0.09012333457631105","host":"s3://npm-registry-packages"}},"1.2.0":{"name":"@c-frame/aframe-particle-system-component","version":"1.2.0","description":"Particle systems for A-Frame.","main":"./index.js","directories":{"example":"examples"},"devDependencies":{"semistandard":"^17.0.0","snazzy":"^9.0.0","webpack":"^5.93.0","webpack-cli":"^5.1.4","webpack-dev-server":"^5.0.4"},"engines":{"node":">= v18.12.0"},"scripts":{"dev":"webpack serve","dist":"webpack && NODE_ENV=production webpack","lint":"semistandard -v | snazzy","prepublish":"npm run dist","start":"npm run dev"},"repository":{"type":"git","url":"git+https://github.com/c-frame/aframe-particle-system-component.git"},"keywords":["ideaspace","c-frame","webvr","aframe-vr","aframe-component","aframe","mozvr","vr"],"author":{"name":"IdeaSpace","email":"info@IdeaSpace.org","url":"https://www.IdeaSpace.org"},"license":"MIT","bugs":{"url":"https://github.com/c-frame/aframe-particle-system-component/issues"},"homepage":"https://github.com/c-frame/aframe-particle-system-component#readme","_id":"@c-frame/aframe-particle-system-component@1.2.0","gitHead":"fc4b617a5d90549854dcc38f18efb54d59a2392f","_nodeVersion":"22.7.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-kTPpgWZruTfSJAjE2VuxcuVPl2pTKZOXnieJslWXvSbTI80gC9oVXvBkuRb9EeUNBjWEhcMlSwAcCJJB9C3Zsg==","shasum":"2cbd5db4d788c55785671185888be51284b8cf0c","tarball":"https://registry.npmjs.org/@c-frame/aframe-particle-system-component/-/aframe-particle-system-component-1.2.0.tgz","fileCount":22,"unpackedSize":732958,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICjS5lUrJSQjINlwZcNdf9cO+/YN9wxg1u4/BE8k92MUAiA1WzAnPFdQufnC8Scke0eU4d9YwQxoulRt9MUBB6fA/A=="}]},"_npmUser":{"name":"vincentfretin","email":"vincent.fretin@gmail.com"},"maintainers":[{"name":"kfarr","email":"kieran.farr@gmail.com"},{"name":"diarmidmackenzie","email":"diarmid.mackenzie@gmail.com"},{"name":"vincentfretin","email":"vincent.fretin@gmail.com"},{"name":"finetype","email":"finesttype@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aframe-particle-system-component_1.2.0_1725695818671_0.43971148561251705"},"_hasShrinkwrap":false}},"time":{"created":"2023-01-12T09:02:41.522Z","modified":"2024-09-07T07:56:59.265Z","1.1.4":"2023-01-12T09:02:41.792Z","1.2.0":"2024-09-07T07:56:58.963Z"},"bugs":{"url":"https://github.com/c-frame/aframe-particle-system-component/issues"},"author":{"name":"IdeaSpace","email":"info@IdeaSpace.org","url":"https://www.IdeaSpace.org"},"license":"MIT","homepage":"https://github.com/c-frame/aframe-particle-system-component#readme","keywords":["ideaspace","c-frame","webvr","aframe-vr","aframe-component","aframe","mozvr","vr"],"repository":{"type":"git","url":"git+https://github.com/c-frame/aframe-particle-system-component.git"},"description":"Particle systems for A-Frame.","maintainers":[{"name":"kfarr","email":"kieran.farr@gmail.com"},{"name":"diarmidmackenzie","email":"diarmid.mackenzie@gmail.com"},{"name":"vincentfretin","email":"vincent.fretin@gmail.com"},{"name":"finetype","email":"finesttype@gmail.com"}],"readme":"# aframe-particle-system-component\n\nParticle system component for [A-Frame](https://aframe.io).\n\n![Particle System](https://cloud.githubusercontent.com/assets/674727/24214966/6d43ef14-0ef4-11e7-973f-c561b81d175f.gif)\n\n### Examples\n\n- [Stars](https://c-frame.github.io/aframe-particle-system-component/examples/stars/)\n- [Dust](https://c-frame.github.io/aframe-particle-system-component/examples/dust/)\n- [Rain](https://c-frame.github.io/aframe-particle-system-component/examples/rain/)\n- [Snow](https://c-frame.github.io/aframe-particle-system-component/examples/snow/)\n- [Colors](https://c-frame.github.io/aframe-particle-system-component/examples/colors/)\n\n### Properties\n\nThis component exposes only a subset of the [ShaderParticleEngine API](http://squarefeet.github.io/ShaderParticleEngine/docs/api/).\n\n| Property           | Description                                                                                                                                                                                                                                     | Default Value        |\n|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|\n| preset              | Preset configuration. Possible values are: `default`, `dust`, `snow`, `rain`.                                                                                                                                                                   | `default`            |\n| maxAge              | The particle's maximum age in seconds.                                                                                                                                                                                                          | `6`                  |\n| positionSpread      | Describes this emitter's position variance on a per-particle basis.                                                                                                                                                                             | `0 0 0`              |\n| type                | The default distribution this emitter should use to control its particle's spawn position and force behaviour. Possible values are `1` (box), `2` (sphere), `3` (disc)                                                                          | 1 (box)              |\n| rotationAxis        | Describes this emitter's axis of rotation. Possible values are `x`, `y` and `z`.                                                                                                                                                                | `x`                  |\n| rotationAngle       | The angle of rotation, given in radians. `Dust` preset is `3.14`.                                                                                                                                                                               | `0`                  |\n| rotationAngleSpread | The amount of variance in the angle of rotation per-particle, given in radians.                                                                                                                                                                 | `0`                  |\n| accelerationValue   | Describes this emitter's base acceleration.                                                                                                                                                                                                     | `0, -10, 0`          |\n| accelerationSpread  | Describes this emitter's acceleration variance on a per-particle basis.                                                                                                                                                                         | `10 0 10`            |\n| velocityValue       | Describes this emitter's base velocity.                                                                                                                                                                                                         | `0 25 0`             |\n| velocitySpread      | Describes this emitter's acceleration variance on a per-particle basis.                                                                                                                                                                         | `10 7.5 10`          |\n| dragValue           | Number between 0 and 1 describing drag applied to all particles.                                                                                                                                                                                | `0`                  |\n| dragSpread          | Number describing drag variance on a per-particle basis.                                                                                                                                                                                        | `0`                  |\n| dragRandomise       | WHen a particle is re-spawned, whether it's drag should be re-randomised or not. Can incur a performance hit.                                                                                                                                   | `false`              |\n| color               | Describes a particle's color. This property is a \"value-over-lifetime\" property, meaning an array of values can be given to describe specific value changes over a particle's lifetime.                                                         | `#0000FF,#FF0000`    |\n| size                | Describes a particle's size.  Either a single number, or an array of values can be given to describe specific value changes over a particle's lifetime.                                                                                   | `1`                  |\n| sizeSpread | Per-particle variation in size.  Either a single number, or an array of values can be given to describe specific value changes over a particle's lifetime. | 0 |\n| direction           | The direction of the emitter. If value is `1`, emitter will start at beginning of particle's lifecycle. If value is `-1`, emitter will start at end of particle's lifecycle and work it's way backwards.                                        | `1`                  |\n| duration            | The duration in seconds that this emitter should live for. If not specified, the emitter will emit particles indefinitely.                                                                                                                      | `null`               |\n| enabled             | When `true` the emitter will emit particles, when `false` it will not. This value can be changed dynamically during a scene. While particles are emitting, they will disappear immediately when set to `false`.  | `true`               |\n| particleCount       | The total number of particles this emitter will hold. NOTE: this is not the number of particles emitted in a second, or anything like that. The number of particles emitted per-second is calculated by particleCount / maxAge (approximately!) | `1000`               |\n| texture             | The texture used by this emitter.                                                                                                                                                                                                               | `./images/star2.png` |\n| randomise           | When a particle is re-spawned, whether it's position should be re-randomised or not. Can incur a performance hit.                                                                                                                               | `false`              |\n| opacity             | Either a single number to describe the opacity of a particle, or an array of values can be given to describe specific value changes over a particle's lifetime.                                                                               | `1`                  |\n| opacitySpread | Per-particle variation in opacity.  Either a single number, or an array of values can be given to describe specific value changes over a particle's lifetime. | 0 |\n| blending            | The blending mode of the particles. Possible values are `0` (no blending), `1` (normal), `2` (additive), `3` (subtractive), `4` (multiply)                                                                                                      | `2`                  |\n| maxParticleCount    |                                                                                                                                                                                                                                                 | `250000`             |\n\n### Usage\n\n```html\n<a-entity position=\"0 2.25 -15\" particle-system=\"preset: dust\"></a-entity>\n```\n\n```html\n<a-entity position=\"0 2.25 -15\" particle-system=\"preset: snow\"></a-entity>\n```\n\n```html\n<a-entity position=\"0 2.25 -15\" particle-system=\"preset: rain\"></a-entity>\n```\n\n```html\n<a-entity position=\"0 2.25 -15\" particle-system=\"preset: dust; texture: ./images/star2.png; color: #0000FF,#00FF00,#FF0000\"></a-entity>\n```\n\n### Functions\n\n#### startParticles\nEnables the emitters. Useful to start the animations when `enabled` is set to `false`.\n\n#### stopParticles\nDisables the emitters.\n\n### Usage\n```javascript\nthis.el.components['particle-system'].startParticles();\nthis.el.components['particle-system'].stopParticles();\n```\n\n### Browser Installation\n\nInstall and use by directly including the [browser files](dist).\n\n```html\n<!DOCTYPE html>\n<html>\n  <head>\n    <meta charset=\"utf-8\">\n    <title>A-Frame Particle System Component Example</title>\n    <meta name=\"description\" content=\"Hello, World!\">\n    <script src=\"https://aframe.io/releases/1.6.0/aframe.min.js\"></script>\n    <script src=\"https://cdn.jsdelivr.net/gh/c-frame/aframe-particle-system-component@1.2.0/dist/aframe-particle-system-component.min.js\"></script>\n  </head>\n  <body>\n    <a-scene>\n      <!-- Particle system uses 'default' preset, setting custom colors. -->\n      <a-entity position=\"0 2.25 -15\" particle-system=\"color: #EF0000,#44CC00\"></a-entity>\n\n      <a-sphere position=\"0 1.25 -1\" radius=\"1.25\" color=\"#EF2D5E\"></a-sphere>\n      <a-box position=\"-1 0.5 1\" rotation=\"0 45 0\" width=\"1\" height=\"1\" depth=\"1\"  color=\"#4CC3D9\"></a-box>\n      <a-cylinder position=\"1 0.75 1\" radius=\"0.5\" height=\"1.5\" color=\"#FFC65D\"></a-cylinder>\n      <a-plane rotation=\"-90 0 0\" width=\"4\" height=\"4\" color=\"#7BC8A4\"></a-plane>\n\n      <a-sky color=\"#000000\"></a-sky>\n    </a-scene>\n  </body>\n</html>\n```\n\n### npm\n\nhttps://www.npmjs.com/package/aframe-particle-system-component\n\n```\nnpm install aframe-particle-system-component\n```\n\n### Local Development\n\n```\nnpm install\nnpm run dev   # Changes are only in the served version, not dist/aframe-particle-system-component.js\n```\n\nTo rebuild:\n\n```\nnpm run dist\n```\n\n### Credits\n\nBased on the [ShaderParticleEngine by Squarefeet](https://github.com/squarefeet/ShaderParticleEngine).\n","readmeFilename":"README.md"}