Add lua script

Author: dustymethod

BrowserImageSlideshow.html

@@ -1,7 +1,8 @@
 <!--
 
-BrowserImageSlideshow v1.1
+BrowserImageSlideshow v1.2
 https://github.com/dustymethod/BrowserImageSlideshow
+https://obsproject.com/forum/threads/random-image-slideshow.110157/
 
 -->
 <div id="imageContainer"></div>
@@ -48,7 +49,7 @@
     images.pop();
     for (let i = images.length-1; i >= 0; i--) {
         // remove js, sh, or directory
-        let remove = images[i].includes(".js") || images[i].includes(".sh") || !images[i].includes(".");
+        let remove = images[i].includes(".js") || images[i].includes(".sh") || !images[i].includes(".") || images[i].includes(".git");
         if (remove) {
             images.splice(i, 1);
         }

README.txt

@@ -1,30 +1,43 @@
-BrowserImageSlideshow v1.1
+BrowserImageSlideshow v1.2
 https://github.com/dustymethod/BrowserImageSlideshow
+Discussion & support: https://obsproject.com/forum/threads/random-image-slideshow.110157/
 
-A local browser source for OBS that plays images in random or alphabetical order. Has no image count limit.
+A local browser source for OBS that plays images in random or alphabetical order.
+Displays each image exactly one per loop.
 
 Modes (settings.js)
-    0: Random order (default). Displays each image exactly once per loop.
+    0: Random order
     1: Alphabetical order
-    2: Alphabetical order (start at random image)
+    2: Alphabetical order (start at random image when source becomes visible)
 
 Setup
 0. Download: click "Clone or download" from the github page, choose "Download ZIP", and unzip the files.
-1. In OBS Studio or Streamlabs OBS:
+    - save the zip somewhere in your Documents folder, and not in the default obs-plugins folder.
+1. Add the browser source in OBS:
     - Add Source > Browser
-    - Add local file "BrowserImageSlideshow.html"
+    - Choose local file "BrowserImageSlideshow.html"
     - Remove Custom CSS
-    - Check "Shutdown source when not visible" and "Refresh browser when scene becomes active"
-2. Place your images in the "images" folder. jpg, png, gifs all work.
-3. Refresh images - This must be done whenever images are added or renamed!
-    - Run RefreshImagesW.cmd (for windows) or RefreshImages.sh (for linux)
+    - Enable "Shutdown source when not visible" and "Refresh browser when scene becomes active" options.
+2: Add the lua script:
+    - Tools > Scripts
+    - Add RefreshImagesLua.lua. Select the script to view settings.
+3. Place slideshow images in the "images" folder. jpg, png, gifs all work.
+4. Refresh images/settings
+    - This must be done whenever images are added/removed/renamed, or when settings are updated.
+    - OBS > Tools > Scripts: select script & press Reload scripts button
     - Refresh the source in OBS by toggling its visibility
-4. *** Repeat step 3 whenever you add or rename images, or they won't appear! ***
+5. *** Repeat step 4 whenever you add/remove/rename images or update the settings. ***
+
 
 Notes
-    - settings.js can be opened & edited in notepad. (includes slide duration & mode settings)
-    - To use updated settings, refresh source by toggling visibility
-    - The RefreshImages script saves a list of all images in the images folder in "images.js"
+    - Adding RefreshImageLua.lua to OBS is optional. if not used, the list of images needs to be updated 
+    manually by running RefreshImagesW.cmd (windows) or RefreshImages.sh (linux)
+    - settings.js can be opened & edited manually in any text editor. (includes slide duration & mode settings)
+    - updating settings thru RefreshImagesLua.lua will overwrite settings.js
     - Filenames with uncommon characters may not display
+    - OBS's slideshow currently preloads all slideshow images, and has a 250MB limit.
+    This browser source doesn't preload images, and has no 250MB limit.
 
-Discussion & support: https://obsproject.com/forum/threads/random-image-slideshow.110157/
+Issues
+    - because of the way script(s) write to a file, a harmless command window will pop up briefly when the script is run.
+    Haven't found a way to suppress this yet.

RefreshImagesLua.lua

@@ -0,0 +1,82 @@
+--[=====[ 
+
+v1.2
+https://obsproject.com/forum/resources/random-image-slideshow.852/
+https://github.com/dustymethod/BrowserImageSlideshow
+
+--]=====]
+
+obs = obslua
+
+mode = 0
+slideDuration = 3800
+imageCount = 0
+defaultSlideDuration = 4000
+minSlideDuration = 1000
+maxSlideDuration = 100000
+
+function script_description()
+	return "Script for the slideshow browser source. Saves a list of images in images/images.js, and saves settings in settings.js. See README for full details. " ..
+    "Is run automatically when OBS is launched.\n\n" ..
+
+    "*** Whenever settings or images are updated, reload the script & refresh the browser to use updated settings/images: \n"..
+    "- Reload script: press the reload button with this script selected.\n"..
+    "- Refresh browser source: toggle the source's visiblity off and on\n"..
+    
+    "\nModes: \n" ..
+    "0: Random order\n" ..
+    "1: Alphabetical order\n" ..
+    "2: Alphabetical order (start at random image when source becomes visible)"
+end
+
+function script_properties()
+    props = obs.obs_properties_create()
+    obs.obs_properties_add_int(props, "mode", "Mode:", 0, 2, 1)
+    obs.obs_properties_add_int(props, "slideDuration", "Slide duration (ms):", minSlideDuration, maxSlideDuration, 500)
+    return props
+end
+
+-- called when script is loaded
+function script_load(settings)
+    obs.obs_data_set_default_int(settings, "slideDuration", defaultSlideDuration)
+    refresh_images()
+end
+
+-- called when script settings change
+function script_update(settings)
+    mode = obs.obs_data_get_int(settings, "mode")
+    slideDuration = obs.obs_data_get_int(settings, "slideDuration")
+    update_slideshow_settings()
+end
+
+-- write settings to js file
+function update_slideshow_settings()
+    local output = assert(io.open(script_path() .. 'settings.js', "w"))
+    
+    output:write('let mode = '.. mode .. ';\n')
+    output:write('let slideDuration = '.. slideDuration .. ';\n')
+    output:close()
+end
+
+-- write list of images to js file
+function update_image_list(dir)
+    local output = assert(io.open(script_path() .. 'images/images.js', "w"))
+    local files = assert(io.popen('dir "'..dir..'" /b'))
+    output:write('let imageNamesStr=`\n')
+    imageCount = 0
+    
+    for line in files:lines() do
+        output:write(line .. "\n")
+        imageCount = imageCount + 1
+        --print(line)
+    end
+    
+    files:close()
+    output:write('`')
+    output:close()
+end
+
+function refresh_images()
+    local list = update_image_list(script_path() .. 'images/')
+    print("Refreshed images (images: ".. imageCount .." | mode: ".. mode .." | duration: ".. slideDuration .. ")")
+end

settings.js

@@ -1,10 +1,2 @@
-// duration in ms
-let slideDuration = 3800;
-
-// modes:
-// 0 (default): random order. Displays each image exactly once per loop.
-// 1: Alphabetical order
-// 2: Alphabetical order (start at random image)
 let mode = 0;
-
-/* Don't forget to refresh the source in OBS after changing the settings! */
+let slideDuration = 4000;