From 936e5204bd5f66eca6af63c393f8b42fb8ff0b0c Mon Sep 17 00:00:00 2001 From: Bradford Nelson Date: Wed, 5 Apr 2023 20:41:31 -0500 Subject: [PATCH] md update for Major version change --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index cf1a1e2..2e6cc1c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # OBS Stream Automation -Using [Node.js](https://nodejs.org/) and [obs-websocket](https://github.com/obsproject/obs-websocket) to automate our live stream. +Using [Node.js](https://nodejs.org/) and [@b3nelly/change-obs-scene](https://github.com/web3nelly/change-obs-scene#readme) package for dynamically switching scenes in OBS. + See Automations in action @ [breaking3Dreality on Twitch.tv](https://www.twitch.tv/breaking3Dreality) **More automates to come!** @@ -10,7 +11,7 @@ See Automations in action @ [breaking3Dreality on Twitch.tv](https://www.twitch. - [OBS](https://obsproject.com/) - [Node.js](https://nodejs.org/) - [NPM](https://www.npmjs.com/) -- [@b3nelly/change-obs-scene](https://www.npmjs.com/package/@b3nelly/change-obs-scene) for dynamically switching scenes in OBS. +- [@b3nelly/change-obs-scene](https://www.npmjs.com/package/@b3nelly/change-obs-scene?activeTab=readme) ## Usage @@ -26,19 +27,23 @@ See Automations in action @ [breaking3Dreality on Twitch.tv](https://www.twitch. 5. Create .env file and add your OBS WebSocket Server Settings: - Windows Powershell: - ``` + ```shell New-Item .env -ItemType File >> "OBS_WS='ws://localhost:4455'" | Out-File -FilePath .env -Encoding utf8 -Append >> "OBS_WS_PASS='yourPassword'" | Out-File -FilePath .env -Encoding utf8 -Append >> "OBS_SCENE_INT_SECS=90" | Out-File -FilePath .env -Encoding utf8 -Append ``` - macOS & Linux: `touch .env` - ``` + ```shell echo "OBS_WS='ws://localhost:4455'" >> .env echo "OBS_WS_PASS='yourPassword'" >> .env echo "OBS_SCENE_INT_SECS=90" >> .env ``` - -6. `npm start` (OBS must me started to work.) -7. You can change the duration to switch scenes on this line: https://github.com/b3nelly2/obs-stream-automation/blob/5b7261dd928b7faf3a204a2bc4c206d5eba4ffe3/changeScene.js#L5 -8. That's it, for now 😉 +- Or you can just edit the `changeScene.js`, manually update your: + - `obsSkipScenes`: Default is an empty array + - `intervalInSeconds`: Default is 45s + - `obsWebSocketServerURL`: Default is ws://localhost:4455 + - `obsWebSocketServerPassword`: Default is undefined + +6. `npm start` (OBS must me started to work) +7. That's it, for now 😉