Visual_Plugin_Browser_v1

HOW TO START USING :

• ReaPack: Install ReaPack (package manager for REAPER scripts/extensions).
• Install required packages (via ReaPack):
  • ReaImGui (ImGui bindings)
  • JS_ReaScriptAPI (JS API that provides window capture & file dialogs)
  • X‑Raym Screenshot script: look for “X‑Raym_Screenshot FX on selected tracks.lua” (used by the script to capture FX windows).
• Copy script: put MyVisualPluginBrowser.lua into your REAPER scripts folder (or open it directly in Action List → ReaScript → Load).
• Open and run: Actions → ReaScript → Load MyVisualPluginBrowser.lua, then run it from the Action List.

Initial configuration (one-time)

• Set the screenshot action ID:
  • After installing the X‑Raym script, open the Action List and find that action.
  • Copy its Command ID (looks like _RSxxxxxxxxxxxx...).
  • Edit the top of MyVisualPluginBrowser.lua and set SCREENSHOT_COMMAND_ID = "<your_command_id>".
• Optional: increase timeouts if you have slow or bridged plugins:
  • Edit OPEN_WAIT_FRAMES (default ~20) — try 40–60 for slow GUIs.
  • Edit other waits if necessary (SCAN_WAIT_FRAMES / SCAN_POST_CAPTURE_FRAMES in the script variations).

How to use — the quick workflow

• Run the script window.
• Top controls:
  • REFRESH: re-enumerate installed plugins (use after installing/uninstalling plugins).
  • RELOAD IMAGES: clear image cache and reload PNG thumbnails from disk.
  • Remove orphan thumbnails: deletes PNGs in the thumbnail folder that no longer match installed plugins.
  • Generate Previews (One-shot): creates only missing thumbnails and resumes where it left off (safe to run repeatedly).
  • SCAN & GENERATE: full automated pass that tries to automatically capture every plugin UI.
• Per plugin (grid item):
  • If thumbnail exists: Replace (choose a file to overwrite), Clear (delete existing thumbnail).
  • If no thumbnail: Load Image (pick a PNG to use), Skip (mark plugin skipped — becomes red Skipped).
  • Clicking the image/box also adds the plugin to the currently selected track in REAPER.
• Files produced:
  • Thumbnails folder: %APPDATA%/REAPER/Data/track_icons/FX_Thumbnails
  • Log: scan_log.txt in that folder
  • Progress: scan_progress.txt
  • Skip list: skip_list.txt

If something gets stuck / common fixes

• Plugin window appears but PNG is missing:
  • Increase OPEN_WAIT_FRAMES to 40–60 and retry (some UIs load slowly or are bridged).
  • If still failing, mark with Skip and use Load Image to supply your own screenshot.
• File dialog error when loading images:
  • Ensure JS_ReaScriptAPI is installed; the script uses GetUserFileNameForRead.
• If plugin was uninstalled but PNG remains:
  • Click Remove orphan thumbnails to delete leftover PNGs.
  • Or click REFRESH to update installed plugin list (deleted plugins disappear from the UI).
• Check scan_log.txt for capture errors and retry messages.

Where to edit script settings

• Open MyVisualPluginBrowser.lua and change:
  • SCREENSHOT_COMMAND_ID → set your screenshot action ID
  • OPEN_WAIT_FRAMES → increase for slow plugins
  • MAX_CAPTURE_RETRIES → increase how many times the scanner retries capture before skipping

Tips

• Run Generate Previews (One-shot) first — it’s safe and fast (only makes missing images).
• Use Skip for bridged or crashy plugins, then Load Image/Replace with a screenshot you capture manually.
• Use Remove orphan thumbnails occasionally to keep the thumbnails folder tidy.

Documentation added

• I created a full README: README.md. It contains step-by-step setup, UI walkthrough, and troubleshooting.

Want me to automatically open the thumbnails folder in Explorer from the UI, or add confirmation dialogs before destructive actions (Clear / Remove orphan thumbnails)? Which one first?