@koreez/phaser-particle-editor-plugin

Phaser Particle Editor Plugin

Stats

StarsIssuesVersionUpdatedCreatedSize
@koreez/phaser-particle-editor-plugin
2541.0.0-alpha.214 years ago4 years agoMinified + gzip package size for @koreez/phaser-particle-editor-plugin in KB

Readme

Phaser Particle Editor Plugin

Build Status David Project status

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

Getting Started

Installation

Using script tag:

<script src="//cdn.jsdelivr.net/npm/@koreez/phaser-particle-editor-plugin/dist/plugin.min.js"></script>

Using npm:

npm

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

Usage

Import the plugin

CommonJS
var ParticleEditorPlugin = require("@koreez/phaser-particle-editor-plugin");
ES2015
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.

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

// 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 so you can always be up to date with latest news!

Contributing

Coming soon!

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.