/Proton

A particle engine for html5

Primary LanguageJavaScript

Proton

The documentation is available here

Proton is an easily customizable html5 particle engine including six different types of renderers.
Check out examples at http://a-jie.github.io/Proton/

Features

  • Six kinds of renderers
    • canvas
    • dom
    • webgl
    • easeljs
    • pixel
    • pixijs
  • Create cool effects like the demo of 71squared's ParticleDesigner in 10 lines of code.
  • Integratable into any game engine
  • Veriety of behaviors
  • Three kinds of emitters which can simulate many different physical effects
  • The 3D version of the proton engine is here https://a-jie.github.io/three.proton/

Installation

Install using npm

anix

npm install proton-js --save
... 
import Proton from 'proton-js';

Include in html

<script type="text/javascript" src="js/proton.min.js"></script> 

Usage

var proton = new Proton();
var emitter = new Proton.Emitter();

//set Rate
emitter.rate = new Proton.Rate(Proton.getSpan(10, 20), 0.1);

//add Initialize
emitter.addInitialize(new Proton.Radius(1, 12));
emitter.addInitialize(new Proton.Life(2, 4));
emitter.addInitialize(new Proton.Velocity(3, Proton.getSpan(0, 360), 'polar'));

//add Behaviour
emitter.addBehaviour(new Proton.Color('ff0000', 'random'));
emitter.addBehaviour(new Proton.Alpha(1, 0));

//set emitter position
emitter.p.x = canvas.width / 2;
emitter.p.y = canvas.height / 2;
emitter.emit();

//add emitter to the proton
proton.addEmitter(emitter);

// add canvas renderer
var renderer = new Proton.Renderer('canvas', proton, canvas);
renderer.start();

//use Euler integration calculation is more accurate (default false)
Proton.USE_CLOCK = false or true;

Building Proton

Node is a dependency, use terminal to install it with with:
git clone git://github.com/a-jie/Proton.git

Then navigate to the build directory by running:

cd ./build
node build.js

Or use npm script

npm run build

Changelog

Detailed changes for each release are documented in the release notes.

License

Proton is released under the MIT License. http://www.opensource.org/licenses/mit-license