Repository files navigation

This project contains a collection ofbash scripts that will build various streamlabs projects like streamlabs/obs-studio for Windows/Mac & install it in other projects.Windows users likely want to run these scripts fromGit Bash.

Install this folder in the same directory right beside streamlabs-desktop, streamlabs-obs-studio, and streamlabs/obs-studio-node. This project containsbash scripts

root folder (ex., streamlabs folder)-->slobs-buildScripts (this repo)-->streamlabs/desktop-->streamlabs/obs-studio (aka SLOBS)-->streamlabs/obs-studio-node (aka OSN)

Download all of these repos fromgithub first. Runrebuild-slobs.sh to build SLOBS. Next, runrebuild-osn.sh which will create a fake .app bundle for the automated tests. The advantage here it mimics what thegithub workflow does.Note: Xcode currently defaults to Debug for OSN & SLOBS but the build scripts are configured for RelWithDebugInfo. You can ask the build script for Help (-h) to show you how to change the build configuration (such as./rebuild-slobs.sh -h). Lastly, runrebuild-desktop.sh.

When you make changes to code, just hit⌘+Shift+B (or CTRL+SHIFT+B on Windows) in Visual Studio Code to copy over the updated artifacts (behind the scenes this will runupdate-everything-from-slobs.sh). Sometimes drastic changes may require rebuild which means runningrebuild-osn.sh --clean. This will trigger a complete rebuild of obs-studio-node causing it to redownload all deps. Grab a coffee this might take a few mins. Note- the local libobs_src folder will be replaced by the downloaded artifact (set by LibOBSVersion). You'll likely want to runinstall-slobs.sh to overwrite this with your local changes.

Below is example how you would execute this in terminal on Mac:

./rebuild-slobs.sh./rebuild-osn.sh./install-slobs.sh --build=Debug./install-osn.sh --build=Debug

Runupdate-everything-from-SLOBS.sh script (via the⌘+Shift+B hotkey combination) to buildstreamlabs/obs-studio &obs-studio-node. The resulting artifacts will be copied intostreamlabs/desktop. Now when you execute theyarn run test command in OSN directory, it will utilize the latest compiled artifact. In addition,desktop will also be updated.

If you want to enable mac-virtual-cam on macOS 12.3+ you'll need to define the following environment variableCODESIGN_TEAM to enable automatic codesign in xcode.

If you just want to build the Streamlabs desktop.app then just run the following scripts:rebuild-desktop.sh andbuild-frontend-desktop-app.sh scripts. After the desktop app has been built into your dist folder, run therun-local-arm64-desktop-app.sh script. This script will prevent the updater from starting and attempt to download the preview.

Eventually, some of these scripts will likely get copied over into their respective repos where appropriate. But they will take a slightly different form in those repos so they can be ran viayarn.