Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dylarm committed Apr 17, 2021
1 parent 52e1bd1 commit 2949782
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ An in-stream source toggle for if recording is active or not
If recording is active, then the specified source is visible.
If recording is not active, then the source is not visible.

## Instructions
If you are using Windows, make sure to have Python 3.6 installed and OBS Studio configured to use it.

1. Download the [latest release](https://github.com/dylarm/obs-recording-indicator/releases/latest)
2. Extract/unzip the archive so you can access `recording-indicator.py`
3. In OBS Studio, go to Tools → Scripts
4. Click the "+" button to add `recording-indicator.py`

## Current limitations
* Source visibility is only changed _after_ a scene transition. Depending on the transition, this can be strange
* Source must be manually added (and positioned) to each scene it will be used it (this may or may not be a limitation?)

0 comments on commit 2949782

Please sign in to comment.