Skip to content

Commit

Permalink
md update for Major version change
Browse files Browse the repository at this point in the history
  • Loading branch information
web3nelly committed Apr 6, 2023
1 parent 5b4ffac commit 936e520
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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!**
Expand All @@ -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

Expand All @@ -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 😉

0 comments on commit 936e520

Please sign in to comment.