https://github.com/koreezgames/phaser-particle-editor-plugin

This plugin creates particles based on JSON data generated by Phaser Particle Editor
https://github.com/koreezgames/phaser-particle-editor-plugin

emitter game games particle particles phaser phaser-game phaser-plugin phaserjs

Last synced: 3 months ago
JSON representation

This plugin creates particles based on JSON data generated by Phaser Particle Editor

• Host: GitHub
• URL: https://github.com/koreezgames/phaser-particle-editor-plugin
• Owner: koreezgames
• License: mit
• Created: 2017-10-09T09:57:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-07-29T11:47:19.000Z (over 6 years ago)
• Last Synced: 2024-10-30T00:43:18.332Z (3 months ago)
• Topics: emitter, game, games, particle, particles, phaser, phaser-game, phaser-plugin, phaserjs
• Language: JavaScript
• Homepage: https://phaser-particle-editor.firebaseapp.com
• Size: 104 KB
• Stars: 31
• Watchers: 6
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Phaser Particle Editor Plugin

[![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)

This plugin creates particle effects based on JSON data generated by **[Phaser Particle Editor](https://phaser-particle-editor.firebaseapp.com/)**

## Getting Started

### Installation

#### **_Using script tag:_**

[![](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)

```html

```

#### **_Using npm:_**

[![npm](https://img.shields.io/npm/dt/@koreez/phaser-particle-editor-plugin.svg)](https://www.npmjs.com/package/@koreez/phaser-particle-editor-plugin)

```shell

$ npm i -g npm

$ npm i --save  @koreez/phaser-particle-editor-plugin

```

## Usage

### Import the plugin

##### **_CommonJS_**

```javascript

var ParticleEditorPlugin = require("@koreez/phaser-particle-editor-plugin");

```

##### **_ES2015_**

```javascript

import ParticleEditorPlugin from "@koreez/phaser-particle-editor-plugin";

```

### Load the plugin

You need to load the plugin in your game. This is done just like any other plugin in Phaser.

So, to load the plugin, include it one of the Phaser States.

```javascript

game.plugins.add(ParticleEditorPlugin);

```

The plugin will patch your Phaser game with additional _add / make_ methods so this plugin fits up in Phaser like any normal object.

### Create particles

```javascript

// x - any

// y - any

// data - should be already loaded JSON key or existing object based on Particle Editor data

// group - parent container

game.add.particleEffect(x, y, data, group);

// or

game.make.particleEffect(x, y, data);

```

## News & Community

We have a [forum](http://www.html5gamedevs.com/topic/33387-phaser-particle-editor/) so you can always be up to date with latest news!

## Contributing

Coming soon!