VOD unlocker Save-As download (#51) + README redesign - #53
Merged
Conversation
Addresses issue #51. The downloader wrote the script to a fixed %APPDATA%\obs-studio\scripts path, which missed portable and non-standard OBS installs. The script is now embedded (include_str!) and served at GET /obs/vod-script/download as a Content-Disposition attachment; the dashboard uses the File System Access API (showSaveFilePicker) so the user picks where it lands, with a plain download fallback on browsers without it. No network round-trip, no release-asset version skew. Remove the now-dead install_vod_script, obs_scripts_dir, vod_script_installed, self_update::download_latest_asset, the POST /obs/vod-script/install route, and the vod_script_installed field on /obs/register-status. Also collapse the legacy "OBS quick launch" (Enhanced Broadcasting via --config-url) into an expandable section on OBS 32.2+, where OBS ignores that flag for custom services.
Full restructure toward a benefit-first order (Quickstart, Why, Features, then How it works), a benefit-card hero and a rebuilt 3-step Arm/Activate/Cut graphic, deep internals folded into collapsed sections, a Download CTA and a SmartScreen note near the top, and an FAQ answered from actual behavior. SEO pass weaves in multistream/simulcast and the free Restream/InstantDelay alternative framing, plus a Spanish "delay" synonym. Drops the stale binary-size mentions and fixes kbd misuse on states/ports. New asset docs/pipeline.svg (benefit-card hero); docs/states.svg reworked into a smoothed single-cycle loop.
# Conflicts: # README.es.md # README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two things on one branch: the fix for the open VOD-unlocker download bug (#51), and a full README redesign.
fix: VOD unlocker downloads where the user chooses (Closes #51)
The downloader wrote the script to a fixed
%APPDATA%\obs-studio\scriptspath, which silently missed portable and non-standard OBS installs (the root cause reported in #51). Now:include_str!) and served atGET /obs/vod-script/downloadwith aContent-Dispositionattachment.showSaveFilePicker) so the user picks the folder, with a plain-download fallback on browsers without it.install_vod_script,obs_scripts_dir,vod_script_installed,self_update::download_latest_asset, thePOST /obs/vod-script/installroute, and thevod_script_installedfield on/obs/register-status.--config-url) now collapses into an expandable section on OBS 32.2+, where OBS ignores that flag for custom services.docs: README redesign (EN + ES)
docs/pipeline.svg) and a rebuilt, smoothed 3-step Arm/Activate/Cut graphic (docs/states.svg).<kbd>to<code>accessibility fixes on states/ports.Testing
cargo build --releaseandcargo clippy --all-targets -- -D warningsclean; 282 tests green.GET /obs/vod-script/downloadreturns the byte-identical script with the attachment header,showSaveFilePickeris present in the served HTML, and the oldPOST /obs/vod-script/installroute 404s.Notes