mz-particles/README.md

TypeScript library for creating particle effects on canvas.

# ミ☆ mzParticles ☆彡

[![GitHub license](https://img.shields.io/github/license/mzusin/mz-particles)](https://github.com/mzusin/mz-particles/blob/main/LICENSE)
![GitHub package.json version](https://img.shields.io/github/package-json/v/mzusin/mz-particles)

**mzParticles** is a TypeScript library for creating particle effects on canvas.

https://user-images.githubusercontent.com/128969497/234193978-3ca7e010-a3e4-4705-a98e-1c1750d15688.mov

## Live Examples
- [math.mzsoft.org](https://math.mzsoft.org/)

## Features ✔️
- Based on [TypeScript](https://www.typescriptlang.org/).
- Supports rotation effect.
- Supports fade in/out effect.
- Supports scale in/out effect.
- Optional connecting lines between particles.
- Allows to combine various effects together.
- Can provide SVG path data as particle shapes.
- Size, color and shape of particles are customizable.
- The library handles window resizes.
- The number of particles and the size of the connecting lines can be different on different devices.

## Documentation 🔖
### Main 
- [Basic Usage](https://particles.mzsoft.org/pages/basic-usage.html)
### Shapes 
- [Circles](https://particles.mzsoft.org/pages/circles.html)
- [Stars](https://particles.mzsoft.org/pages/stars.html)
- [Triangles](https://particles.mzsoft.org/pages/triangles.html)
### Settings 
- [Settings](https://particles.mzsoft.org/pages/settings.html)
- [Canvas Settings](https://particles.mzsoft.org/pages/canvas-settings.html)
- [Particles Number](https://particles.mzsoft.org/pages/particles-number.html)
- [Particles Settings](https://particles.mzsoft.org/pages/particles-settings.html)
- [Connecting Lines](https://particles.mzsoft.org/pages/connecting-lines.html)
- [Rotation Effect](https://particles.mzsoft.org/pages/rotation-effect.html)
- [Scale Effect](https://particles.mzsoft.org/pages/scale-effect.html)
- [Fade Effect](https://particles.mzsoft.org/pages/fade-effect.html)
------------------------------
































































































































































































































































































































































































































































































## License

[MIT license](https://github.com/mzusin/mz-particles/blob/main/LICENSE.md)

It can be used **for free** in any personal or commercial project :gift: