Skip to content

Commit 9591a71

Browse files
715209715209
committed
Update readme
1 parent fd088af commit 9591a71

File tree

1 file changed

+39
-36
lines changed

1 file changed

+39
-36
lines changed

‎README.md

Lines changed: 39 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,31 @@
44
██╔██╗ ██║██║ ██║███████║██║ ██████╔╝███████╗
55
██║╚██╗██║██║ ██║██╔══██║██║ ██╔══██╗╚════██║
66
██║ ╚████║╚██████╔╝██║ ██║███████╗██████╔╝███████║
7-
╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝╚══════╝╚═════╝ ╚══════╝ v1.0.2
8-
```
7+
╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝╚══════╝╚═════╝ ╚══════╝ v1.2.0
8+
```
99

1010
# nginx-obs-automatic-low-bitrate-switching
1111

1212
Simple app to automatically switch scenes in OBS based on the current bitrate fetched from the NGINX stats page.
1313

1414
## Build Prerequisities
1515

16-
- [Git](http://git-scm.com/)
17-
- [Node.js](http://nodejs.org/) (with NPM)
16+
- [Git](http://git-scm.com/)
17+
- [Node.js](http://nodejs.org/) (with NPM)
18+
19+
> This script uses OBS plugin "obs-websocket" inconjuction with "OBS-Studio" and "NGINX-RTMP" (see links below).
1820
19-
>This script uses OBS plugin "obs-websocket" inconjuction with "OBS-Studio" and "NGINX-RTMP" (see links below).
20-
- [NGINX-RTMP](https://github.com/arut/nginx-rtmp-module/)
21-
- [OBS-Studio](https://github.com/obsproject/obs-studio/)
22-
- [OBS-WEBSOCKET](https://github.com/Palakis/obs-websocket/)
21+
- [NGINX-RTMP](https://github.com/arut/nginx-rtmp-module/)
22+
- [OBS-Studio](https://github.com/obsproject/obs-studio/)
23+
- [OBS-WEBSOCKET](https://github.com/Palakis/obs-websocket/)
2324

2425
## Installation from Source
2526

26-
- `git clone <repository-url>`
27-
- Change into the new directory.
28-
- `npm install --production`
29-
- Replace your `nginx.conf` with the one given here.
30-
- Put `stat.xsl` in your nginx folder.
27+
- `git clone <repository-url>`
28+
- Change into the new directory.
29+
- `npm install --production`
30+
- Replace your `nginx.conf` with the one given here.
31+
- Put `stat.xsl` in your nginx folder.
3132

3233
## Config
3334

@@ -36,8 +37,8 @@ Edit `config.json` to your own settings.
3637
Here is an example config with comments (click to enlarge):
3738
![alt text](https://i.imgur.com/cVbz1bN.png "Configuration Comments (Click to Enlarge)")
3839

39-
- Use https://twitchapps.com/tmi to get your oauth from Twitch for use with chat commands.
40-
> We recommend using your main Twitch BOT account for this, but if you do not have a Twitch Bot account just use your Main Twitch Account.
40+
- Use https://twitchapps.com/tmi to get your oauth from Twitch for use with chat commands.
41+
> We recommend using your main Twitch BOT account for this, but if you do not have a Twitch Bot account just use your Main Twitch Account.
4142
4243
Also if you are going to be using your Twitch BOT Account please make sure it is an 'Editor' of your channel, see example;
4344

@@ -52,30 +53,32 @@ Run the node app by running: `npm start`. Then stream to `rtmp://IPHERE/publish/
5253
## Chat Commands
5354

5455
This script gives you the option to enable some simple chat commands to help you manage your stream from your own Twitch chat, here is how to use them:
55-
>Please note: Admins are all the users in the "adminUsers" array in the config, MODs (if enabled in the config) are all of your MODs, and Public (if enabled in the config) is anyone in your chat.
56-
57-
>| Default Role | Command | Description | Example |
58-
>|:-------:| ---------------- |:-------------| :----------------------|
59-
>| Admins | !host (channelname) | hosts said channel, and stops streaming in OBS if enabled in config. | !host 715209 |
60-
>| Admins | !unhost | unhosts whoever you are currently hosting. | !unhost |
61-
>| Admins | !raid (channelname) | raids said channel and stops streaming in OBS if enabled in config. | !raid 715209 |
62-
>| Admins | !start | on-demand command to start streaming in OBS. | !start |
63-
>| Admins | !stop | on-demand command to stop streaming in OBS. | !stop |
64-
>| Admins | !switch (scene) | switches to the provided SCENE (case senstive). | !switch INTRO|
65-
>| MODs | !refresh | changes to the REFRESH scene for the set interval. | !refresh |
66-
>| MODs | !trigger (value) | changes the low bitrate threshold to the defined value. | !trigger 1000 |
67-
>| MODs | !sourceinfo | gives you details about the SOURCE in chat. | !sourceinfo |
68-
>| MODs | !obsinfo | gives you details about OBS in chat. | !obsinfo |
69-
>| Public | !bitrate | returns current BITRATE | !bitrate |
56+
57+
> Please note: Admins are all the users in the "adminUsers" array in the config, MODs (if enabled in the config) are all of your MODs, and Public (if enabled in the config) is anyone in your chat.
58+
59+
> | Default Role | Command | Description | Example |
60+
> | :----------: | ------------------- | :------------------------------------------------------------------- | :------------ |
61+
> | Admins | !host (channelname) | hosts said channel, and stops streaming in OBS if enabled in config. | !host 715209 |
62+
> | Admins | !unhost | unhosts whoever you are currently hosting. | !unhost |
63+
> | Admins | !raid (channelname) | raids said channel and stops streaming in OBS if enabled in config. | !raid 715209 |
64+
> | Admins | !start | on-demand command to start streaming in OBS. | !start |
65+
> | Admins | !stop | on-demand command to stop streaming in OBS. | !stop |
66+
> | Admins | !rec (on/off) | on-demand command to start/stop recording in OBS. | !rec on |
67+
> | Admins | !switch (scene) | switches to the provided SCENE (case senstive). | !switch INTRO |
68+
> | MODs | !refresh | changes to the REFRESH scene for the set interval. | !refresh |
69+
> | MODs | !trigger (value) | changes the low bitrate threshold to the defined value. | !trigger 1000 |
70+
> | MODs | !sourceinfo | gives you details about the SOURCE in chat. | !sourceinfo |
71+
> | MODs | !obsinfo | gives you details about OBS in chat. | !obsinfo |
72+
> | Public | !bitrate | returns current BITRATE | !bitrate |
7073
7174
You can also enable/disable certain features from chat, see below:
72-
>| Default Role | Command | Description | Example |
73-
>|:-------:| ---------------- |:-------------| :----------------------|
74-
>| Admins | !public (on/off) | enables/disables the use of Public commands. | !public off |
75-
>| Admins | !mod (on/off) | enables/disables the use of MOD commands. | !mod on |
76-
>| Admins | !notify (on/off) | enables/disables the notifications in chat. | !notify off |
77-
>| Admins | !autostop (on/off) | enables/disables the auto stop feature when you host/raid. | !autostop on |
7875

76+
> | Default Role | Command | Description | Example |
77+
> | :----------: | ------------------ | :--------------------------------------------------------- | :----------- |
78+
> | Admins | !public (on/off) | enables/disables the use of Public commands. | !public off |
79+
> | Admins | !mod (on/off) | enables/disables the use of MOD commands. | !mod on |
80+
> | Admins | !notify (on/off) | enables/disables the notifications in chat. | !notify off |
81+
> | Admins | !autostop (on/off) | enables/disables the auto stop feature when you host/raid. | !autostop on |
7982
8083
## Help it won't change scenes
8184

0 commit comments

Comments
 (0)