@tsparticles/plugin-sounds 3.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Matteo Bruni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+[![banner](https://particles.js.org/images/banner2.png)](https://particles.js.org)
+
+# tsParticles Sounds Plugin
+
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/tsparticles-plugin-sounds/badge)](https://www.jsdelivr.com/package/npm/tsparticles-plugin-sounds)
+[![npmjs](https://badge.fury.io/js/tsparticles-plugin-sounds.svg)](https://www.npmjs.com/package/tsparticles-plugin-sounds)
+[![npmjs](https://img.shields.io/npm/dt/tsparticles-plugin-sounds)](https://www.npmjs.com/package/tsparticles-plugin-sounds) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+
+[tsParticles](https://github.com/matteobruni/tsparticles) plugin for particles sounds effect.
+
+## How to use it
+
+### CDN / Vanilla JS / jQuery
+
+The CDN/Vanilla version JS has one required file in vanilla configuration:
+
+Including the `tsparticles.plugin.sounds.min.js` file will export the function to load the plugin:
+
+```javascript
+loadSoundsPlugin;
+```
+
+### Usage
+
+Once the scripts are loaded you can set up `tsParticles` and the plugin like this:
+
+```javascript
+(async () => {
+  await loadSoundsPlugin(tsParticles);
+
+  await tsParticles.load({
+    id: "tsparticles",
+    options: {
+      /* options */
+    },
+  });
+})();
+```
+
+### ESM / CommonJS
+
+This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:
+
+```shell
+$ npm install tsparticles-plugin-sounds
+```
+
+or
+
+```shell
+$ yarn add tsparticles-plugin-sounds
+```
+
+Then you need to import it in the app, like this:
+
+```javascript
+const { tsParticles } = require("tsparticles-engine");
+const { loadSoundsPlugin } = require("tsparticles-plugin-sounds");
+
+loadSoundsPlugin(tsParticles); // awaitable
+```
+
+or
+
+```javascript
+import { tsParticles } from "tsparticles-engine";
+import { loadSoundsPlugin } from "tsparticles-plugin-sounds";
+
+loadSoundsPlugin(tsParticles); // awaitable
+```

package/browser/Options/Classes/Sounds.js

@@ -0,0 +1,30 @@
+import { SoundsEvent } from "./SoundsEvent";
+import { SoundsIcons } from "./SoundsIcons";
+import { SoundsVolume } from "./SoundsVolume";
+export class Sounds {
+    constructor() {
+        this.enable = false;
+        this.events = [];
+        this.icons = new SoundsIcons();
+        this.volume = new SoundsVolume();
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
+        if (data.events !== undefined) {
+            this.events = data.events.map((t) => {
+                const event = new SoundsEvent();
+                event.load(t);
+                return event;
+            });
+        }
+        this.icons.load(data.icons);
+        if (data.volume !== undefined) {
+            this.volume.load(data.volume);
+        }
+    }
+}

package/browser/Options/Classes/SoundsAudio.js

@@ -0,0 +1,22 @@
+export class SoundsAudio {
+    constructor() {
+        this.loop = false;
+        this.source = "";
+    }
+    load(data) {
+        if (data === undefined) {
+            return;
+        }
+        if (typeof data === "object") {
+            if (data.loop !== undefined) {
+                this.loop = data.loop;
+            }
+            if (data.source !== undefined) {
+                this.source = data.source;
+            }
+        }
+        else {
+            this.source = data;
+        }
+    }
+}

package/browser/Options/Classes/SoundsEvent.js

@@ -0,0 +1,54 @@
+import { SoundsAudio } from "./SoundsAudio";
+import { SoundsMelody } from "./SoundsMelody";
+import { SoundsNote } from "./SoundsNote";
+export class SoundsEvent {
+    constructor() {
+        this.event = [];
+        this.notes = [];
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.event !== undefined) {
+            this.event = data.event;
+        }
+        if (data.audio !== undefined) {
+            if (data.audio instanceof Array) {
+                this.audio = data.audio.map((s) => {
+                    const tmp = new SoundsAudio();
+                    tmp.load(s);
+                    return tmp;
+                });
+            }
+            else {
+                this.audio = new SoundsAudio();
+                this.audio.load(data.audio);
+            }
+        }
+        if (data.notes !== undefined) {
+            this.notes = data.notes.map((t) => {
+                const tmp = new SoundsNote();
+                tmp.load(t);
+                return tmp;
+            });
+        }
+        if (data.melodies !== undefined) {
+            this.melodies = data.melodies.map((t) => {
+                const tmp = new SoundsMelody();
+                tmp.load(t);
+                return tmp;
+            });
+        }
+        if (data.filter !== undefined) {
+            if (typeof data.filter === "string") {
+                if (typeof window[data.filter] === "function") {
+                    this.filter = window[data.filter];
+                }
+            }
+            else {
+                this.filter = data.filter;
+            }
+        }
+    }
+}

package/browser/Options/Classes/SoundsIcon.js

@@ -0,0 +1,23 @@
+export class SoundsIcon {
+    constructor() {
+        this.width = 24;
+        this.height = 24;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.path !== undefined) {
+            this.path = data.path;
+        }
+        if (data.svg !== undefined) {
+            this.svg = data.svg;
+        }
+        if (data.width !== undefined) {
+            this.width = data.width;
+        }
+        if (data.height !== undefined) {
+            this.height = data.height;
+        }
+    }
+}

package/browser/Options/Classes/SoundsIcons.js

@@ -0,0 +1,54 @@
+import { SoundsIcon } from "./SoundsIcon";
+export class SoundsIcons {
+    constructor() {
+        this.mute = new SoundsIcon();
+        this.unmute = new SoundsIcon();
+        this.volumeDown = new SoundsIcon();
+        this.volumeUp = new SoundsIcon();
+        this.mute.svg = `<?xml version="1.0"?>
+<svg baseProfile="tiny" height="24px" version="1.2" viewBox="0 0 24 24" width="24px"
+    xml:space="preserve" xmlns="http://www.w3.org/2000/svg"
+    xmlns:xlink="http://www.w3.org/1999/xlink">
+    <g id="Layer_1">
+        <path fill="#fff" d="M19.707,5.293c-0.391-0.391-1.023-0.391-1.414,0l-1.551,1.551c-0.345-0.688-0.987-1.02-1.604-1.02c-0.449,0-0.905,0.152-1.356,0.453l-2.672,1.781C10.357,8.561,8.904,9,8,9c-1.654,0-3,1.346-3,3v2c0,1.237,0.754,2.302,1.826,2.76l-1.533,1.533c-0.391,0.391-0.391,1.023,0,1.414C5.488,19.902,5.744,20,6,20s0.512-0.098,0.707-0.293l2.527-2.527c0.697,0.174,1.416,0.455,1.875,0.762l2.672,1.781c0.451,0.301,0.907,0.453,1.356,0.453C16.035,20.176,17,19.495,17,18V9.414l2.707-2.707C20.098,6.316,20.098,5.684,19.707,5.293z M14.891,7.941c0.038-0.025,0.073-0.046,0.104-0.062C14.998,7.914,15,7.954,15,8v1.293l-2,2V9.202L14.891,7.941z M7,12c0-0.552,0.448-1,1-1c1.211,0,2.907-0.495,4-1.146v2.439l-2.83,2.83C8.757,15.046,8.356,15,8,15c-0.552,0-1-0.448-1-1V12z M10.301,15.406L12,13.707v2.439C11.519,15.859,10.925,15.604,10.301,15.406z M14.994,18.12c-0.03-0.016-0.065-0.036-0.104-0.062L13,16.798v-4.091l2-2V18C15,18.046,14.998,18.086,14.994,18.12z"/>
+    </g>
+</svg>`;
+        this.unmute.svg = `<?xml version="1.0"?>
+<svg baseProfile="tiny" height="24px" version="1.2" viewBox="0 0 24 24" width="24px"
+    xml:space="preserve" xmlns="http://www.w3.org/2000/svg"
+    xmlns:xlink="http://www.w3.org/1999/xlink">
+    <g id="Layer_1">
+        <path fill="#fff" d="M17.138,5.824c-0.449,0-0.905,0.152-1.356,0.453l-2.672,1.781C12.357,8.561,10.904,9,10,9c-1.654,0-3,1.346-3,3v2c0,1.654,1.346,3,3,3c0.904,0,2.357,0.439,3.109,0.941l2.672,1.781c0.451,0.301,0.907,0.453,1.356,0.453C18.035,20.176,19,19.495,19,18V8C19,6.505,18.035,5.824,17.138,5.824z M14,16.146C12.907,15.495,11.211,15,10,15c-0.552,0-1-0.448-1-1v-2c0-0.552,0.448-1,1-1c1.211,0,2.907-0.495,4-1.146V16.146z M17,18c0,0.046-0.002,0.086-0.006,0.12c-0.03-0.016-0.065-0.036-0.104-0.062L15,16.798V9.202l1.891-1.261c0.038-0.025,0.073-0.046,0.104-0.062C16.998,7.914,17,7.954,17,8V18z"/>
+    </g>
+</svg>`;
+        this.volumeDown.svg = `<?xml version="1.0"?>
+<svg baseProfile="tiny" height="24px" version="1.2" viewBox="0 0 24 24" width="24px"
+    xml:space="preserve" xmlns="http://www.w3.org/2000/svg"
+    xmlns:xlink="http://www.w3.org/1999/xlink">
+    <g id="Layer_1">
+        <path fill="#fff" d="M15.138,5.824c-0.449,0-0.905,0.152-1.356,0.453l-2.672,1.781C10.357,8.561,8.904,9,8,9c-1.654,0-3,1.346-3,3v2c0,1.654,1.346,3,3,3c0.904,0,2.357,0.439,3.109,0.941l2.672,1.781c0.451,0.301,0.907,0.453,1.356,0.453C16.035,20.176,17,19.495,17,18V8C17,6.505,16.035,5.824,15.138,5.824z M8,15c-0.552,0-1-0.448-1-1v-2c0-0.552,0.448-1,1-1c1.211,0,2.907-0.495,4-1.146v6.293C10.907,15.495,9.211,15,8,15z M15,18c0,0.046-0.002,0.086-0.006,0.12c-0.03-0.016-0.065-0.036-0.104-0.062L13,16.798V9.202l1.891-1.261c0.038-0.025,0.073-0.046,0.104-0.062C14.998,7.914,15,7.954,15,8V18z"/>
+        <path fill="#fff" d="M18.292,10.294c-0.39,0.391-0.39,1.023,0.002,1.414c0.345,0.345,0.535,0.803,0.535,1.291c0,0.489-0.19,0.948-0.536,1.294c-0.391,0.39-0.391,1.023,0,1.414C18.488,15.902,18.744,16,19,16s0.512-0.098,0.707-0.293c0.724-0.723,1.122-1.685,1.122-2.708s-0.398-1.984-1.123-2.707C19.317,9.903,18.683,9.901,18.292,10.294z"/>
+    </g>
+</svg>`;
+        this.volumeUp.svg = `<?xml version="1.0"?>
+<svg baseProfile="tiny" height="24px" version="1.2" viewBox="0 0 24 24" width="24px"
+    xml:space="preserve" xmlns="http://www.w3.org/2000/svg"
+    xmlns:xlink="http://www.w3.org/1999/xlink">
+    <g id="Layer_1">
+        <path fill="#fff" d="M16.706,10.292c-0.389-0.389-1.023-0.391-1.414,0.002c-0.39,0.391-0.39,1.023,0.002,1.414c0.345,0.345,0.535,0.803,0.535,1.291c0,0.489-0.19,0.948-0.536,1.294c-0.391,0.39-0.391,1.023,0,1.414C15.488,15.902,15.744,16,16,16s0.512-0.098,0.707-0.293c0.724-0.723,1.122-1.685,1.122-2.708S17.431,11.015,16.706,10.292z"/>
+        <path fill="#fff" d="M18.706,8.292c-0.391-0.389-1.023-0.39-1.414,0.002c-0.39,0.391-0.39,1.024,0.002,1.414c0.879,0.877,1.363,2.044,1.364,3.287c0.001,1.246-0.484,2.417-1.365,3.298c-0.391,0.391-0.391,1.023,0,1.414C17.488,17.902,17.744,18,18,18s0.512-0.098,0.707-0.293c1.259-1.259,1.952-2.933,1.951-4.713C20.657,11.217,19.964,9.547,18.706,8.292z"/>
+        <path fill="#fff" d="M20.706,6.292c-0.391-0.389-1.023-0.39-1.414,0.002c-0.39,0.391-0.39,1.024,0.002,1.414c1.412,1.409,2.191,3.285,2.192,5.284c0.002,2.002-0.777,3.885-2.193,5.301c-0.391,0.391-0.391,1.023,0,1.414C19.488,19.902,19.744,20,20,20s0.512-0.098,0.707-0.293c1.794-1.794,2.781-4.18,2.779-6.717C23.485,10.457,22.497,8.078,20.706,6.292z"/>
+        <path fill="#fff" d="M12.138,5.824c-0.449,0-0.905,0.152-1.356,0.453L8.109,8.059C7.357,8.561,5.904,9,5,9c-1.654,0-3,1.346-3,3v2c0,1.654,1.346,3,3,3c0.904,0,2.357,0.439,3.109,0.941l2.672,1.781c0.451,0.301,0.907,0.453,1.356,0.453C13.035,20.176,14,19.495,14,18V8C14,6.505,13.035,5.824,12.138,5.824z M5,15c-0.552,0-1-0.448-1-1v-2c0-0.552,0.448-1,1-1c1.211,0,2.907-0.495,4-1.146v6.293C7.907,15.495,6.211,15,5,15z M12,18c0,0.046-0.002,0.086-0.006,0.12c-0.03-0.016-0.065-0.036-0.104-0.062L10,16.798V9.202l1.891-1.261c0.038-0.025,0.073-0.046,0.104-0.062C11.998,7.914,12,7.954,12,8V18z"/>
+    </g>
+</svg>`;
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        this.mute.load(data.mute);
+        this.unmute.load(data.unmute);
+        this.volumeDown.load(data.volumeDown);
+        this.volumeUp.load(data.volumeUp);
+    }
+}

package/browser/Options/Classes/SoundsMelody.js

@@ -0,0 +1,30 @@
+import { SoundsNote } from "./SoundsNote";
+export class SoundsMelody {
+    constructor() {
+        this.loop = false;
+        this.melodies = [];
+        this.notes = [];
+    }
+    load(data) {
+        if (data === undefined) {
+            return;
+        }
+        if (data.loop !== undefined) {
+            this.loop = data.loop;
+        }
+        if (data.melodies !== undefined) {
+            this.melodies = data.melodies.map((s) => {
+                const tmp = new SoundsMelody();
+                tmp.load(s);
+                return tmp;
+            });
+        }
+        if (data.notes !== undefined) {
+            this.notes = data.notes.map((s) => {
+                const tmp = new SoundsNote();
+                tmp.load(s);
+                return tmp;
+            });
+        }
+    }
+}

package/browser/Options/Classes/SoundsNote.js

@@ -0,0 +1,17 @@
+export class SoundsNote {
+    constructor() {
+        this.duration = 500;
+        this.value = [];
+    }
+    load(data) {
+        if (!data) {
+            return;
+        }
+        if (data.duration !== undefined) {
+            this.duration = data.duration;
+        }
+        if (data.value !== undefined) {
+            this.value = data.value;
+        }
+    }
+}

package/browser/Options/Classes/SoundsVolume.js

@@ -0,0 +1,30 @@
+export class SoundsVolume {
+    constructor() {
+        this.value = 100;
+        this.max = 100;
+        this.min = 0;
+        this.step = 10;
+    }
+    load(data) {
+        if (data === undefined) {
+            return;
+        }
+        if (typeof data === "object") {
+            if (data.max !== undefined) {
+                this.max = data.max;
+            }
+            if (data.min !== undefined) {
+                this.min = data.min;
+            }
+            if (data.step !== undefined) {
+                this.step = data.step;
+            }
+            if (data.value !== undefined) {
+                this.value = data.value;
+            }
+        }
+        else {
+            this.value = data;
+        }
+    }
+}

package/browser/Options/Interfaces/ISounds.js

@@ -0,0 +1 @@
+export {};

package/browser/Options/Interfaces/ISoundsAudio.js

@@ -0,0 +1 @@
+export {};

package/browser/Options/Interfaces/ISoundsEvent.js

@@ -0,0 +1 @@
+export {};

package/browser/Options/Interfaces/ISoundsIcon.js

@@ -0,0 +1 @@
+export {};

package/browser/Options/Interfaces/ISoundsIcons.js

@@ -0,0 +1 @@
+export {};

package/browser/Options/Interfaces/ISoundsMelody.js

@@ -0,0 +1 @@
+export {};

package/browser/Options/Interfaces/ISoundsNote.js

@@ -0,0 +1 @@
+export {};

package/browser/Options/Interfaces/ISoundsVolume.js

@@ -0,0 +1 @@
+export {};