Merge remote-tracking branch 'pl/decrease-volume'

Author: antobinary

.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

.eslintrc

@@ -0,0 +1,44 @@
+
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "extends": [
+        "airbnb",
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "parserOptions": {
+      "ecmaVersion": 2020
+    },
+    "plugins": [
+        "@typescript-eslint",
+        "react",
+        "jsx-a11y",
+        "import"
+    ],
+    "env": {
+      "es6": true,
+      "node": true,
+      "browser": true
+    },
+    "rules": {
+      "react/jsx-filename-extension": [1, { "extensions": [".tsx", ".jsx"] }],
+      "no-shadow": "off",
+      "@typescript-eslint/no-shadow": "warn",
+      "import/prefer-default-export": "off",
+      "no-underscore-dangle": 0,
+      "import/extensions": [2, "never"],
+      "import/no-absolute-path": 0,
+      "import/no-unresolved": 0,
+      "import/no-extraneous-dependencies": 1,
+      "react/prop-types": 1,
+      "jsx-a11y/no-access-key": 0,
+      "react/jsx-props-no-spreading": "off",
+      "max-classes-per-file": "off",
+      "class-methods-use-this": "off"
+    },
+    "globals": {
+      "browser": "writable"
+    }
+  }

README.md

@@ -1,17 +1,49 @@
-# Repository of a plugin for BigBlueButton
+# Decrease external video's volume on speak
 
-## Description
+## What is it?
 
-A brief description of the plugin including a screenshot or a short video.
+This plugin is one of the official bbb plugins. It basically decreases the external video's volume when a user is speaking in the meeting.
 
-## Running the Plugin From Source Code
+## Running the Plugin from Source
+
+1. Start the development server:
+
+```bash
+cd $HOME/src/plugins/decrease-volume-on-speak
+npm install
+npm start
+```
+
+2. Add reference to it on BigBlueButton's `settings.yml`:
+
+```yaml
+  plugins:
+    - name: DecreaseVolumeOnSpeak
+      url: http://127.0.0.1:4701/static/DecreaseVolumeOnSpeak.js
+```
 
 ## Building the Plugin
 
+To build the plugin for production use, follow these steps:
+
+```bash
+cd $HOME/src/plugins/decrease-volume-on-speak
+npm install
+npm run build-bundle
+```
+
+The above command will generate the `dist` folder, containing the bundled JavaScript file named `DecreaseVolumeOnSpeak.js`. This file can be hosted on any HTTPS server.
 
-## Background
+To use the plugin with BigBlueButton, add the plugin's URL to `settings.yml` as shown below:
 
-BigBlueButton added supports for plugins in 2024 with BBB 3.0.
-Check the official [documentation website](https://docs.bigbluebutton.org) for more information.
+```yaml
+public:
+  app:
+    ... // All app configurations
+  plugins:
+    - name: DecreaseVolumeOnSpeak
+      url: <<PLUGIN_URL>>
+  ... // All other configurations
+```
 
-This plugin repository was created using the plugin [template repository for BigBlueButton](https://github.com/bigbluebutton/plugin-template) hosted on GitHub.
+Alternatively, you can host the bundled file on the BigBlueButton server by copying `dist/DecreaseVolumeOnSpeak.js` to the folder `/var/www/bigbluebutton-default/assets/plugins`. In this case, the `<<PLUGIN_URL>>` will be `https://<your-host>/plugins/DecreaseVolumeOnSpeak.js`.