1- BrowserImageSlideshow v1.2
1+ BrowserImageSlideshow v1.3
22https://github.com/dustymethod/BrowserImageSlideshow
33Discussion & support: https://obsproject.com/forum/threads/browser-image-slideshow.110157/
44
55A local browser source that plays images in random or alphabetical order.
66Displays each image exactly once per loop.
77Useful for slideshows that may exceed OBS's slideshow's 250mb ram limit. Works offline.
88
9- settings.js (can be opened & edited manually in any text editor )
9+ settings.js (open in any text editor. ex right click > Open with > Notepad )
1010 mode:
1111 0: Random order (default)
1212 1: Alphabetical order
@@ -16,32 +16,37 @@ settings.js (can be opened & edited manually in any text editor)
1616
1717
1818Setup
19- 0. Download: click "Clone or download" from the github page, choose "Download ZIP", and unzip the files.
20- - save the zip somewhere in your Documents folder, and not in the default obs- plugins folder.
21- 1. Add the browser source in OBS:
19+ 0. Download the zipped files from github or the releases page
20+ - save & unzip somewhere in your Documents folder ( not in obs plugins folder)
21+ 1. Add a browser source in OBS:
2222 - Add Source > Browser
2323 - Choose local file "BrowserImageSlideshow.html"
2424 - Remove Custom CSS
2525 - Enable "Shutdown source when not visible" and "Refresh browser when scene becomes active" options.
26- 2. Place slideshow images in the "images" folder (ex. jpg, png, gif)
27- 3: (Optional) Add the lua script:
26+ 2. Place your slideshow images in the "images" folder (ex. jpg, png, gif)
27+ 3. (Optional) Add the lua script:
2828 - in OBS Studio: Tools > Scripts
2929 - Add RefreshImagesLua.lua, select the script to view settings.
30- - updating settings via lua script will overwrite settings.js.
31- 4. Refresh images/settings
30+ - this is purely an alternative to using RefreshImagesW.cmd or RefreshImages.sh in step 4
31+ 4. Refreshing images/settings
3232 - This must be done whenever images are added/removed/renamed, or when settings are updated.
33- - if using lua script: select RefreshImagesLua.lua & press Reload scripts button
34- - Or, if not using the lua script, run RefreshImagesW.cmd (windows) or RefreshImages.sh (linux) by double-clicking it.
35- - Refresh the source in OBS by toggling its visibility
36- 5. *** Repeat step 4 whenever you add/remove/rename images or update the settings. ***
33+ - Run RefreshImagesW.cmd (windows) or RefreshImages.sh (linux) by double-clicking it.
34+ - (optional) Or, if using lua script: select RefreshImagesLua.lua & press Reload Scripts button next to +-
35+ - Finally, refresh the source in OBS by toggling its visibility
36+ 5. *** Repeat step 4 whenever you add/remove/rename images or update the settings! ***
37+
3738
3839Notes
39- - Adding RefreshImageLua.lua to OBS Studio is optional. If not used , refreshing images & settings can still be done manually
40+ - Adding RefreshImageLua.lua to OBS Studio is optional. If not using lua , refreshing images & settings can be done
4041 by running RefreshImages.sh or RefreshImagesW.cmd
42+ - Updating settings via the lua script will overwrite settings.js.
43+ - The optional lua script may not work with OBS on Linux; please use RefreshImages.sh instead.
4144 - Filenames with uncommon characters may not display
4245 - EXIF data is ignored; images taken with a camera may not appear rotated correctly
43- - both RefreshImages scripts will write the names of all images to a text file, which is used by the browser source.
46+ - RefreshImages: these scripts will write the names of all images to a text file, which is used by the browser source.
47+ - This resource has only been tested on Windows. I have not done extensive testing
48+ - RefreshImages.sh and RefreshImagesW.cmd do the same thing. one was added later because of compatibility issues
4449
4550Issues
46- - because of the way script(s) write to a file, a harmless command window will pop up briefly when the script is run.
51+ - because of the way script(s) write to a file, a harmless command window may pop up briefly when the script is run.
4752 Haven't found a way to suppress this yet.
0 commit comments