README.md

OBS Stream Automation

Using Node.js and @b3nelly/change-obs-scene package for dynamically switching scenes in OBS.

See Automations in action @ breaking3Dreality on Twitch.tv

More automates to come!

Dependancies

• OBS
• Node.js
• NPM
• dotenv
• @b3nelly/change-obs-scene

Usage

1. Startup OBS and enable the WebSocket Server

• Tools > WebSocket Server Settings:
  • 
  • Don't forget to set your Server Password

2. git clone https://github.com/b3nelly2/obs-stream-automation.git
3. cd ./obs-stream-automation
4. npm install
5. Create .env file and add your OBS WebSocket Server Settings:

• Windows Powershell:

  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

  echo "OBS_WS='ws://localhost:4455'" >> .env
  echo "OBS_WS_PASS='yourPassword'" >> .env
  echo "OBS_SCENE_INT_SECS=90" >> .env

• Or you can just edit the changeScene.js, manuallying update:
  • obsSkipScenes: Default is an empty array
  • intervalInSeconds: Default is 45s
  • obsWebSocketServerURL: Default is ws://localhost:4455
  • obsWebSocketServerPassword: Default is undefined
  • You can also comment out dotevn if you aren't using an .env file
    • Lines 1 and 3:

    • obs-stream-automation/changeScene.js

      Lines 1 to 8 in 936e520

      	import * as dotenv from "dotenv"; // https://github.com/motdotla/dotenv#how-do-i-use-dotenv-with-import
      	import obsSwitchScenes from "@b3nelly/change-obs-scene"; // https://github.com/web3nelly/change-obs-scene
      	https: dotenv.config();
      	const obsSkipScenes = ["Scene 1"];
      	const intervalInSeconds = process.env.OBS_SCENE_INT_SECS ?? 45;
      	const obsWebSocketServerURL = process.env.OBS_WS ?? "ws://localhost:4455";
      	const obsWebSocketServerPassword = process.env.OBS_WS_PASS ?? undefined;

6. npm start (OBS must me started to work)
7. That's it, for now 😉

@b3nelly/change-obs-scene In Action