release: package archives as direct drop-ins to OBS plugin dirs
Release / macOS (macos-latest) (push) Successful in 43s
Release / Linux (ubuntu-24.04) (push) Successful in 51s
Build / Windows (windows-latest) (push) Successful in 10m43s
Build / Linux (ubuntu-24.04) (push) Successful in 52s
Build / macOS (macos-latest) (push) Successful in 28s
Release / Windows (windows-latest) (push) Failing after 16m46s
Release / Create Gitea Release (draft) (push) Skipped

Previously each release zip mirrored build/package/ verbatim (bin/ +
data/ at the archive root), which needed a manual mkdir + cp -r into
the right OBS plugin subdirectory per the install instructions. Wrap
Linux and Windows archives in a top-level streamer-tools-camera/
directory instead -- matching AddExtraModulePaths()'s expected
<config>/obs-studio/plugins/<name>/bin/64bit + data layout -- so
`unzip -d ~/.config/obs-studio/plugins/` (or Expand-Archive to
%APPDATA%\obs-studio\plugins\ on Windows) is the entire install step.

macOS already produced the right shape (the .plugin bundle itself at
the archive's top level, since OBS wants the whole bundle directly
under plugins/, not nested under a named subdirectory) -- no packaging
change needed there, just an install-instructions rewrite plus making
that text properly conditional on MACOS_BUNDLE_FOUND like MACOS_NOTE
already was, since the old hard-coded "not yet that bundle shape" text
was stale once the macOS bundle packaging fix landed.

Verified locally: staged a fake build/package/ tree, ran the new
packaging logic, and confirmed extracting the resulting zip into a
plugins directory produces <name>/bin/64bit/... and <name>/data/...
directly. Also dry-ran publish-release.sh's notes generation for both
MACOS_BUNDLE_FOUND values to confirm the conditional install text
renders correctly.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RL8abRmgFXkVASHkkqiJbE
This commit is contained in:
2026-09-07 08:41:44 -07:00
co-authored by Claude Sonnet 5
parent 14fa00af3f
commit 43a501c06c
2 changed files with 83 additions and 29 deletions
+41 -20
View File
@@ -26,8 +26,27 @@ MACOS_BUNDLE_FOUND="${MACOS_BUNDLE_FOUND:-false}"
if [ "${MACOS_BUNDLE_FOUND}" = "true" ]; then
MACOS_NOTE="This archive contains a \`.plugin\` bundle."
MACOS_INSTALL_HEADING="### macOS (installation path not yet verified in real OBS)"
MACOS_INSTALL_BODY="OBS on macOS loads plugins as \`<name>.plugin\` bundles under
\`~/Library/Application Support/obs-studio/plugins/\`. This archive already
has that shape at its top level -- extract it straight there:
\`\`\`
unzip streamer-tools-camera-${TAG}-macos.zip \\
-d ~/Library/Application\\ Support/obs-studio/plugins/
\`\`\`
No manual copying required. This has not been confirmed against a real OBS
install on macOS -- report back if you try it."
else
MACOS_NOTE="This archive is packaged as a bare \`streamer-tools-camera.so\` (the layout \`build/package/\` currently produces on macOS), **not** an OBS.app-loadable \`.plugin\` bundle. It will not load in the OBS GUI as-is."
MACOS_INSTALL_HEADING="### macOS (installation path not yet verified in real OBS; packaging gap)"
MACOS_INSTALL_BODY="OBS on macOS loads plugins as \`<name>.plugin\` bundles under
\`~/Library/Application Support/obs-studio/plugins/\`. As of this release,
this project's \`build/package/\` output on macOS is **not yet that bundle
shape** -- see the \"macOS packaging gap\" section of \`README.md\`. Treat the
macOS archive here as a build-verification artifact, not a working
drop-in, until that gap is closed."
fi
NOTES_FILE="$(mktemp)"
@@ -71,39 +90,41 @@ watching OBS.
## Installing
Every archive is now shaped as a straight drop-in for its platform's OBS
plugins directory -- extract it directly there, no manual copying of
subfolders required.
### Linux
\`\`\`
mkdir -p ~/.config/obs-studio/plugins/streamer-tools-camera
unzip streamer-tools-camera-${TAG}-linux-x64.zip -d /tmp/stplugin-camera
cp -r /tmp/stplugin-camera/bin /tmp/stplugin-camera/data \\
~/.config/obs-studio/plugins/streamer-tools-camera/
mkdir -p ~/.config/obs-studio/plugins
unzip streamer-tools-camera-${TAG}-linux-x64.zip -d ~/.config/obs-studio/plugins/
\`\`\`
Start OBS, then Sources -> \`+\` -> "streamer-tools Camera" -> fill in the
server URL, room slug and read key from the room's settings page ->
"Refresh camera list" -> pick a camera. This is the same drop-in layout
README's "Testing this by hand" documents for a source build, adapted for a
downloaded zip -- known-good on Linux.
"Refresh camera list" -> pick a camera. Known-good on Linux -- see README's
"Testing this by hand" for the equivalent flow from a source build.
### Windows (installation path not yet verified in real OBS)
Per \`AddExtraModulePaths()\` in obs-studio's \`UI/window-basic-main.cpp\`, OBS
on Windows searches a plugins directory for \`bin\\64bit\\<name>.dll\` plus a
sibling \`data\\\`. Unzip the archive and copy its \`bin\\\` and \`data\\\` into
your OBS plugins directory (typically
\`%APPDATA%\\obs-studio\\plugins\\streamer-tools-camera\\\`), matching the
Linux layout above. This has not been confirmed against a real OBS install on
Windows -- report back if you try it.
on Windows searches \`%APPDATA%\\obs-studio\\plugins\\<name>\\\` for
\`bin\\64bit\\<name>.dll\` plus a sibling \`data\\\`. This archive already has
that \`<name>\\bin\\...\`/\`<name>\\data\\...\` shape at its top level --
extract it straight into the plugins folder:
### macOS (installation path not yet verified in real OBS; packaging gap)
\`\`\`
Expand-Archive streamer-tools-camera-${TAG}-windows-x64.zip \`
-DestinationPath \$env:APPDATA\\obs-studio\\plugins\\
\`\`\`
OBS on macOS loads plugins as \`<name>.plugin\` bundles under
\`~/Library/Application Support/obs-studio/plugins/\`. As of this release,
this project's \`build/package/\` output on macOS is **not yet that bundle
shape** -- see the "macOS packaging gap" section of \`README.md\`. Treat the
macOS archive here as a build-verification artifact, not a working
drop-in, until that gap is closed.
This has not been confirmed against a real OBS install on Windows -- report
back if you try it.
${MACOS_INSTALL_HEADING}
${MACOS_INSTALL_BODY}
## What this is