Major version change '1.0.0' done

.gitignore

@@ -2,7 +2,6 @@
 node_modules/
 test/
 coverage/
-rollup.config.js
 package-lock.json
 
 # Ignore OS-related files

.npmignore

@@ -1,6 +1,7 @@
 # Ignore development-related files and folders
 node_modules/
 test/
+examples/
 coverage/
 rollup.config.js
 package-lock.json

README.md

@@ -1,12 +1,13 @@
 # change-obs-scene
 
-With just a few lines of code, automate changing your OBS scenes using the [@b3nelly/change-obs-scene](https://www.npmjs.com/package/@b3nelly/change-obs-scene?activeTab=readme) npm package.
+With just a few lines of code, automate changing your OBS scenes using the [@b3nelly/change-obs-scene](https://www.npmjs.com/package/@b3nelly/change-obs-scene?activeTab=readme) npm package. 💜
 
 ## Dependancies
 
 - [OBS](https://obsproject.com/)
 - [Node.js](https://nodejs.org/)
 - [NPM](https://www.npmjs.com/)
+- [obs-websocket-js](https://www.npmjs.com/package/obs-websocket-js)
 
 ## Installation
 
@@ -22,41 +23,49 @@ npm install @b3nelly/change-obs-scene
 
 - ![obs websocket server settings](https://github.com/b3nelly2/stream/blob/main/assets/obs-websocket-server-settings.png?raw=true)
 - Don't forget to set your _Server Password_
+- If you do not set a password, you do not need to pass the `obsWebSocketServerPassword` param to `changeScene()`
+
+### Simple Usage Example
+
+```js
+const changeScene = require("@b3nelly/change-obs-scene").default;
+const intervalInSeconds = 30; // 30 seconds per scene
+changeScene(intervalInSeconds); // it's that simple.
+```
 
 ### CommonJS (cjs) Usage Example
 
 ```js
-const obsSwitchScenes =
-  require("@b3nelly/change-obs-scene/dist/obs-switch-scenes.cjs.js").default;
+const changeScene = require("@b3nelly/change-obs-scene").default;
 
 const obsSkipScenes = [];
-const intervalInSeconds = 10;
-const obsWebSocketServerURL = "ws://localhost:4455";
+const intervalInSeconds = 30;
 const obsWebSocketServerPassword = "your-password-here";
+const obsWebSocketServerURL = "ws://localhost:4455";
 
-obsSwitchScenes(
+changeScene(
   intervalInSeconds,
+  obsSkipScenes,
+  obsWebSocketServerPassword
   obsWebSocketServerURL,
-  obsWebSocketServerPassword,
-  obsSkipScenes
 );
 ```
 
 ### ECMAScript Module (esm) Usage Example
 
 ```js
-import obsSwitchScenes from "@b3nelly/change-obs-scene/dist/obs-switch-scenes.esm.js";
+import changeScene from "@b3nelly/change-obs-scene";
 
 const obsSkipScenes = [];
 const intervalInSeconds = 30;
-const obsWebSocketServerURL = "ws://localhost:4455";
 const obsWebSocketServerPassword = "your-password-here";
+const obsWebSocketServerURL = "ws://localhost:4455";
 
-obsSwitchScenes(
+changeScene(
   intervalInSeconds,
+  obsSkipScenes,
+  obsWebSocketServerPassword
   obsWebSocketServerURL,
-  obsWebSocketServerPassword,
-  obsSkipScenes
 );
 ```
 
@@ -73,22 +82,22 @@ obsSwitchScenes(
     <script>
       require.config({
         paths: {
-          obsSwitchScenes:
+          changeScene:
             "@b3nelly/change-obs-scene/dist/obs-switch-scenes.amd",
         },
       });
 
-      require(["obsSwitchScenes"], function (obsSwitchScenes) {
+      require(["changeScene"], function (changeScene) {
         const obsSkipScenes = [];
         const intervalInSeconds = 90;
         const obsWebSocketServerURL = "ws://localhost:4455";
         const obsWebSocketServerPassword = "your-password-here";
 
-        obsSwitchScenes.default(
+        changeScene(
           intervalInSeconds,
+          obsSkipScenes,
+          obsWebSocketServerPassword
           obsWebSocketServerURL,
-          obsWebSocketServerPassword,
-          obsSkipScenes
         );
       });
     </script>
@@ -100,25 +109,39 @@ obsSwitchScenes(
 ## API
 
 ```js
-obsSwitchScenes(
+changeScene(
   intervalInSeconds,
+  obsSkipScenes,
+  obsWebSocketServerPassword
   obsWebSocketServerURL,
-  obsWebSocketServerPassword,
-  obsSkipScenes
 );
 ```
 
-- `intervalInSeconds` _(number, default: `60`)_: Number of seconds between each scene switch.
-- `obsWebSocketServerURL` _(string, default: 'ws_://localhost:4455'): OBS WebSocket Server URL or IP.
-- `obsWebSocketServerPassword` _(string, default: undefined)_: OBS WebSocket Server Password.
-- `obsSkipScenes` _(Array<string>, default: [])_: An array of scene names to skip when switching scenes (scene name must match).
+| Parameter                               |      Type       |         Default          | Description                                           |
+| --------------------------------------- | :-------------: | :----------------------: | ----------------------------------------------------- |
+| `intervalInSeconds` (optional)          |    `number`     |           `60`           | Number of seconds between each scene                  |
+| `obsSkipScenes` (optional)              | `Array<string>` |           `[]`           | An array of scene names to skip when switching scenes |
+| `obsWebSocketServerPassword` (optional) |    `string`     |       `undefined`        | OBS WebSocket Server Password                         |
+| `obsWebSocketServerURL` (optional)      |    `string`     | `"ws_://localhost:4455"` | OBS WebSocket Server URL / IP                         |
+
+## CLI
+
+```shell
+npm run cli
+```
+
+You will be prompted to enter in the `changeSence()` params. Leave param blank to use default value.
 
-## Test
+## Build
 
 ```shell
-npm run test
+npm run build
 ```
 
+Running the `build` command will automatically create the `dist/` dir and create/update the `cjs`, `esm`, and `amd` files inside.
+
+Configuration file [rollup.config.js](https://github.com/web3nelly/change-obs-scene/blob/275bf0d4d8e13b7ae7547e292f0d0997a192806b/rollup.config.js)
+
 ## Development Dependancies
 
 - [@babel/core](https://www.npmjs.com/package/@babel/core)

obs-switch-scenes.js → change-obs-scene.js

@@ -6,19 +6,25 @@ const obs = new OBSWebSocket();
  * Automatically Switch OBS Scene
  *
  * @param  {number} [intervalInSeconds=60] Number of seconds to next scene.
- * @param  {string} [obsWebSocketServerURL='ws://localhost:4455'] OBS WebSocket Server URL or IP.
- * @param  {string} [obsWebSocketServerPassword=undefined] OBS WebSocket Server Password.
  * @param  {array[string]} [array] Add scene/s you would like skip using comma seperated string(scene name must match).
+ * @param  {string} [obsWebSocketServerPassword=undefined] OBS WebSocket Server Password. NOTE, leave undefined if there is no password set.
+ * @param  {string} [obsWebSocketServerURL='ws://localhost:4455'] OBS WebSocket Server URL or IP.
  * @returns {null}
  */
 
-const obsSwitchScenes = (
+const changeScene = (
   intervalInSeconds = 60,
   obsWebSocketServerURL = "ws://localhost:4455",
   obsWebSocketServerPassword = undefined,
   obsSkipScenes = []
 ) => {
-  let currentSceneIndex;
+  if (
+    obsWebSocketServerPassword === null ||
+    obsWebSocketServerPassword === false ||
+    obsWebSocketServerPassword === ""
+  ) {
+    obsWebSocketServerPassword = undefined;
+  }
 
   obs.on("ConnectionOpened", () => {
     console.log("Connection Opened");
@@ -34,7 +40,7 @@ const obsSwitchScenes = (
         switchScene(scenesData, intervalInSeconds);
       })
       .catch((error) => {
-        console.error("Error on GetSceneList call:", error);
+        console.error("Error on GetSceneList call:", error.code, error.message);
       });
   });
 
@@ -47,6 +53,8 @@ const obsSwitchScenes = (
     }
   );
 
+  let currentSceneIndex;
+
   const switchScene = (scenesData, intervalInSecs) => {
     setInterval(() => {
       currentSceneIndex = getNextSceneIndex(
@@ -80,4 +88,4 @@ const obsSwitchScenes = (
   };
 };
 
-export default obsSwitchScenes;
+export default changeScene;

test.js → examples/cli.js

@@ -1,4 +1,4 @@
-import obsSwitchScenes from "./dist/obs-switch-scenes.esm.js";
+import changeScene from "@b3nelly/change-obs-scene";
 import readline from "readline";
 
 const obsSkipScenes = [];
@@ -50,7 +50,7 @@ const askPassword = () => {
   obsWebSocketServerPassword = await askPassword();
   rl.close();
 
-  obsSwitchScenes(
+  changeScene(
     intervalInSeconds,
     obsWebSocketServerURL,
     obsWebSocketServerPassword,

examples/simple.js

@@ -0,0 +1,5 @@
+import changeScene from "@b3nelly/change-obs-scene"; // https://github.com/web3nelly/change-obs-scene
+
+const intervalInSeconds = 30; // 30 seconds per scene
+
+changeScene(intervalInSeconds);

package.json

@@ -1,14 +1,14 @@
 {
   "name": "@b3nelly/change-obs-scene",
-  "version": "0.1.4",
-  "description": "With just a few lines of code, automate changing your OBS scenes.",
+  "version": "1.0.0",
+  "description": "With just a few lines of code, automate changing your OBS scenes. Happy streaming! 💜",
   "author": "web3nelly",
   "license": "MIT",
   "type": "module",
-  "main": "obs-switch-scenes.js",
+  "main": "change-obs-scene.js",
   "scripts": {
     "build": "rollup -c",
-    "test": "node --experimental-modules test.js"
+    "cli": "node --experimental-modules examples/cli.js"
   },
   "repository": {
     "type": "git",

rollup.config.js

@@ -8,18 +8,18 @@ const require = createRequire(import.meta.url);
 const { default: OBSWebSocket } = require("obs-websocket-js");
 
 export default {
-  input: "obs-switch-scenes.js",
+  input: "change-obs-scene.js",
   output: [
     {
-      file: "dist/obs-switch-scenes.cjs.js",
+      file: "dist/change-obs-scene.cjs.js",
       format: "cjs",
     },
     {
-      file: "dist/obs-switch-scenes.esm.js",
+      file: "dist/change-obs-scene.esm.js",
       format: "esm",
     },
     {
-      file: "dist/obs-switch-scenes.amd.js",
+      file: "dist/change-obs-scene.amd.js",
       format: "amd",
       amd: {
         id: "OBSWebSocket",