Skip to content

Commit

Permalink
Merge pull request #622 from Jocke4f/fix_doc_update
Browse files Browse the repository at this point in the history
Doc updates
  • Loading branch information
josephdadams authored Jan 9, 2024
2 parents f0b5d2a + 3e09903 commit a04adb2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/docs/usage/sections/sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ You will need the IP address of the ATEM. The ATEM can only have 5 simultaneous
You will need the IP address of the VideoHub. You can choose to have any destination be configured as a preview bus, program bus, or both. Enter multiple destination routes by separating them with commas.

## OBS Studio
The `obs-websockets` plugin must be installed and configured in order for Tally Arbiter to connect. You can get the plugin here: https://github.com/Palakis/obs-websocket/releases
For OBS Studio v27 (or older) the `obs-websockets` plugin must be installed and configured in order for Tally Arbiter to connect. You can get the plugin here: https://github.com/Palakis/obs-websocket/releases.

For OBS Studio v28 and later is `obs-websockets` included with OBS Studio. Note that the included `obs-websockets` in OBS Studio uses port 4455. This will cause a port conflict with TallyArbiter. In OBS Studion can an alternative port be configured in Tools -> WebSocket Server Settings. An alternative is to re-configure Tally Aribiter with another port by editing the [config file](../../usage/control-interface.md).

You will need to supply the IP address, port, and password configured in the OBS Websockets plugin.

Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ All documentation can be found [here](https://josephdadams.github.io/TallyArbite

## Contributing
Contributions are always welcome. Here's a quick guide on how to setup your local development environment:
1. Install [`Node.js`](https://nodejs.org/en/). You need at least version `14.17`.
1. Install [`Node.js`](https://nodejs.org/en/). You need at least version `18.13`.
1. Make sure you have `npm@7`. This can be checked by running `npm -v`. If your version of `npm` is too old, update it using `npm i -g npm@7`
1. Clone this repository (or your fork): `git clone https://github.com/josephdadams/TallyArbiter`
1. Run `npm install` in the project's root folder
Expand Down

0 comments on commit a04adb2

Please sign in to comment.