Skip to content

Commit

Permalink
update readme to reflect config change
Browse files Browse the repository at this point in the history
  • Loading branch information
reaby committed Apr 16, 2020
1 parent 0bdf544 commit a2d0792
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# LoistoTxt
Title and Subtitlegenerator for OBS with remote scene switcher possibility.
Song lyrics and lower 3rd titles displayer to obs, vmix or any casting software that supports browser source. Additionally you can remote control whitelisted scenes at OBS (required additional plugin to install)

## Install

1. Install `nodejs` and `npm` to your platform (win/linux/mac)
2. Install [obs-websocket](https://github.com/Palakis/obs-websocket/releases) plugin to your obs and set it up.
2. optionally Install [obs-websocket](https://github.com/Palakis/obs-websocket/releases) plugin to your obs and set it up.
3. Get this repo to some folder at your computer

### Windows
Expand All @@ -20,20 +20,22 @@ Title and Subtitlegenerator for OBS with remote scene switcher possibility.
2. start by writing `npm start` at console and follow instructions
3. copy `config-default.json` to `config.json`
4. edit config.json to match your settings

### config.json

structure of the file is quite obvious:

{
"websocket": {
"address": "127.0.0.1:4444",
"password": "admin"
},
"obs": {
"enabled": false,
"scenes": [
"Cam1",
"Cam2"
]
"Example1",
"Example2"
],
"websocket": {
"address": "127.0.0.1:4444",
"password": "admin"
}
}
}

Expand All @@ -55,4 +57,4 @@ After app starts, it says something like this:

Admin interface is without any passwords for now, since well, I don't need such at our production, and you should run this at a private network anyway...

And for OBS, like the console window says, add a new `browser source`, and paste the address there. You might need to click refresh source, if you restart the service, but it should auto connect anyway after you get initial connetion.
And for OBS, like the console window says, add a new `browser source`, and paste the address there. You might need to click refresh source, if you restart the service, but it should auto connect anyway after you get initial connetion.

0 comments on commit a2d0792

Please sign in to comment.