Skip to content

Commit f0874ee

Browse files
committed
Update README.txt
1 parent c1411f1 commit f0874ee

1 file changed

Lines changed: 15 additions & 10 deletions

File tree

README.txt

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,14 @@ A local browser source that plays images in random or alphabetical order.
66
Displays each image exactly once per loop.
77
Useful for slideshows that may exceed OBS's slideshow's 250mb ram limit. Works offline.
88

9-
Modes (settings.js)
10-
0: Random order
11-
1: Alphabetical order
12-
2: Alphabetical order (start at random image when source becomes visible)
9+
settings.js (can be opened & edited manually in any text editor)
10+
mode:
11+
0: Random order (default)
12+
1: Alphabetical order
13+
2: Alphabetical order (start on random image)
14+
slideDuration: duration in milliseconds (default 4000)
15+
stopOnLastImage: if true, the slideshow will not repeat. (default false)
16+
1317

1418
Setup
1519
0. Download: click "Clone or download" from the github page, choose "Download ZIP", and unzip the files.
@@ -19,23 +23,24 @@ Setup
1923
- Choose local file "BrowserImageSlideshow.html"
2024
- Remove Custom CSS
2125
- Enable "Shutdown source when not visible" and "Refresh browser when scene becomes active" options.
22-
2. Place slideshow images in the "images" folder. jpg, png, gifs all work.
23-
3: Add the lua script (optional):
26+
2. Place slideshow images in the "images" folder (ex. jpg, png, gif)
27+
3: (Option) Add the lua script:
2428
- in OBS Studio: Tools > Scripts
25-
- Add RefreshImagesLua.lua. Select the script to view settings.
26-
- updating settings via lua script will overwrite settings.js. the lua script does not load existing settings from settings.js
29+
- Add RefreshImagesLua.lua, select the script to view settings.
30+
- updating settings via lua script will overwrite settings.js.
2731
4. Refresh images/settings
2832
- This must be done whenever images are added/removed/renamed, or when settings are updated.
29-
- OBS Studio > Tools > Scripts: select RefreshImagesLua.lua & press Reload scripts button
33+
- if using lua script: select RefreshImagesLua.lua & press Reload scripts button
3034
- Or, if not using the lua script, run RefreshImagesW.cmd (windows) or RefreshImages.sh (linux) by double-clicking it.
3135
- Refresh the source in OBS by toggling its visibility
3236
5. *** Repeat step 4 whenever you add/remove/rename images or update the settings. ***
3337

3438
Notes
3539
- Adding RefreshImageLua.lua to OBS Studio is optional. If not used, refreshing images & settings can still be done manually
3640
by running RefreshImages.sh or RefreshImagesW.cmd
37-
- settings.js can be opened & edited manually in any text editor. (includes slide duration & mode settings)
3841
- Filenames with uncommon characters may not display
42+
- 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.
3944

4045
Issues
4146
- because of the way script(s) write to a file, a harmless command window will pop up briefly when the script is run.

0 commit comments

Comments
 (0)