{"id":14964064,"url":"https://github.com/koreezgames/phaser-particle-editor-plugin","last_synced_at":"2025-03-30T04:30:45.924Z","repository":{"id":57125465,"uuid":"106266571","full_name":"koreezgames/phaser-particle-editor-plugin","owner":"koreezgames","description":"This plugin creates particles based on JSON data generated by Phaser Particle Editor","archived":false,"fork":false,"pushed_at":"2018-07-29T11:47:19.000Z","size":107,"stargazers_count":31,"open_issues_count":4,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-18T11:25:16.658Z","etag":null,"topics":["emitter","game","games","particle","particles","phaser","phaser-game","phaser-plugin","phaserjs"],"latest_commit_sha":null,"homepage":"https://phaser-particle-editor.firebaseapp.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/koreezgames.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-09T09:57:30.000Z","updated_at":"2024-05-29T11:05:44.000Z","dependencies_parsed_at":"2022-09-10T18:22:16.226Z","dependency_job_id":null,"html_url":"https://github.com/koreezgames/phaser-particle-editor-plugin","commit_stats":null,"previous_names":["koreezgames/phaser-particle-editor-runtime"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koreezgames%2Fphaser-particle-editor-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koreezgames%2Fphaser-particle-editor-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koreezgames%2Fphaser-particle-editor-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koreezgames%2Fphaser-particle-editor-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koreezgames","download_url":"https://codeload.github.com/koreezgames/phaser-particle-editor-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246277352,"owners_count":20751548,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emitter","game","games","particle","particles","phaser","phaser-game","phaser-plugin","phaserjs"],"created_at":"2024-09-24T13:32:32.146Z","updated_at":"2025-03-30T04:30:45.588Z","avatar_url":"https://github.com/koreezgames.png","language":"JavaScript","funding_links":[],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# Phaser Particle Editor Plugin\n\n[![Build Status](https://travis-ci.org/koreezgames/phaser-particle-editor-plugin.svg?branch=master)](https://travis-ci.org/koreezgames/phaser-particle-editor-plugin) [![David](https://david-dm.org/koreezgames/phaser-particle-editor-plugin.svg)]() [![Project status](https://img.shields.io/badge/status-active-brightgreen.svg)](#status)\n\nThis plugin creates particle effects based on JSON data generated by **[Phaser Particle Editor](https://phaser-particle-editor.firebaseapp.com/)**\n\n## Getting Started\n\n### Installation\n\n#### **_Using script tag:_**\n\n[![](https://data.jsdelivr.com/v1/package/npm/@koreez/phaser-particle-editor-plugin/badge?style=rounded)](https://www.jsdelivr.com/package/npm/@koreez/phaser-particle-editor-plugin/dist/plugin.min.js)\n\n```html\n\u003cscript src=\"//cdn.jsdelivr.net/npm/@koreez/phaser-particle-editor-plugin/dist/plugin.min.js\"\u003e\u003c/script\u003e\n```\n\n#### **_Using npm:_**\n\n[![npm](https://img.shields.io/npm/dt/@koreez/phaser-particle-editor-plugin.svg)](https://www.npmjs.com/package/@koreez/phaser-particle-editor-plugin)\n\n```shell\n$ npm i -g npm\n$ npm i --save  @koreez/phaser-particle-editor-plugin\n```\n\n## Usage\n\n### Import the plugin\n\n##### **_CommonJS_**\n\n```javascript\nvar ParticleEditorPlugin = require(\"@koreez/phaser-particle-editor-plugin\");\n```\n\n##### **_ES2015_**\n\n```javascript\nimport ParticleEditorPlugin from \"@koreez/phaser-particle-editor-plugin\";\n```\n\n### Load the plugin\n\nYou need to load the plugin in your game. This is done just like any other plugin in Phaser.\nSo, to load the plugin, include it one of the Phaser States.\n\n```javascript\ngame.plugins.add(ParticleEditorPlugin);\n```\n\nThe plugin will patch your Phaser game with additional _add / make_ methods so this plugin fits up in Phaser like any normal object.\n\n### Create particles\n\n```javascript\n// x - any\n// y - any\n// data - should be already loaded JSON key or existing object based on Particle Editor data\n// group - parent container\ngame.add.particleEffect(x, y, data, group);\n// or\ngame.make.particleEffect(x, y, data);\n```\n\n## News \u0026 Community\n\nWe have a [forum](http://www.html5gamedevs.com/topic/33387-phaser-particle-editor/) so you can always be up to date with latest news!\n\n## Contributing\n\nComing soon!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoreezgames%2Fphaser-particle-editor-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoreezgames%2Fphaser-particle-editor-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoreezgames%2Fphaser-particle-editor-plugin/lists"}