Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jared K committed Apr 13, 2021
1 parent 6ce1b3c commit 9014902
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
4 changes: 2 additions & 2 deletions FUNDING.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: updownleftdie
open_collective: # Replace with a single Open Collective username
ko_fi: https://ko-fi.com/jaredk
ko_fi: jaredk
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom:
[https://www.paypal.me/jaredkotoff, https://www.twitch.tv/subs/updownleftdie]
["https://www.paypal.me/jaredkotoff", "https://www.twitch.tv/subs/updownleftdie", "https://www.guilded.gg/UpDownLeftDie/subscriptions?r=Vmy2GNwA"]
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,29 @@
# OBS Random Video Player

Play videos in random order!
Perfect for BRB screens!

*Perfect for BRB screens!*

## Instructions

1. Copy the `index.html` file or its code
2. Edit the `videosFolder` to point to the folder of videos you want
1. You can set this to `""` if you're placing the html file in the same folder as your videos
3. Add all the videos from that folder to the `videosList`
4. Set a `transitionVideo` or set it to `""` to disable it
5. If you only want one video to play set `playOnlyOne` to `true`
6. Add a new `Browser Source` to OBS
1. Set it to "Local File" and select `index.html` you just edited
2. Set the width and height to your full canvas resolution
3. Check "Shutdown source when not visible"
4. If you want a new shuffle each time: check "Refresh browser when scene becomes active"

## Notes

* Set `Refresh browser when scene becomes active` to randomize on each load
* You can only test this in OBS. Normal desktop chrome won't autoplay videos
* mp3 file should work too
* **Autoplay only works in OBS!**
* If you want to test this in your browser:
1. Open the `index.html` with your browser
2. Right-click on the image and click "Show controls"
3. Hit the play button

0 comments on commit 9014902

Please sign in to comment.