Streamlabs Desktop: three named windows, one JavaScript app, and no Linux build
Free and open source streaming software built on OBS and Electron.
At a glance
- What is it?
- Streamlabs Desktop is a GPL-3.0 Electron and OBS based streaming client for macOS and 64-bit Windows, built on a multi-window architecture where a hidden worker owns the service layer and the main window talks to it over IPC. The developer contract is unusually explicit: asynchronous actions, values read through views, React over Vue, and signing certificates before packaging.
- Who is it for?
- Streamlabs Desktop suits a contributor who can work on macOS or Windows and wants to read a real multi-window Electron codebase with strict conventions about IPC, component style and packaging. It suits nobody on Linux, since the file names no Linux target even though the scripts assume a bash-like shell, and it is a poor base for anything other than a contribution, because the CLA requirement and the translation policy both route changes through the company.
- Can I use it commercially?
- Yes, with conditions. GPL-3.0 is a copyleft licence: if you distribute software that includes it, you must release that software's source code under the same licence. Running it internally without distributing it does not trigger that obligation.
- Is it still maintained?
- Yes. The repository last received commits 1 day ago.
- What is it written in?
- Mainly TypeScript, according to GitHub's language statistics.
Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.
Star history
- streamlabs/desktop4,875 ★ · +21
| Repository | 2026-09-23 | 2026-11-15 |
|---|---|---|
| streamlabs/desktop | 4.9k | 4.9k |
21 Stars in the last 53 days, measured from the daily GitHub snapshot. Compare with other projects
Editorial analysis
The support statement is one sentence and it excludes Linux
Platform support is stated in a single line: the application currently only supports OSX 10.14+ and 64-bit Windows. That single sentence is the first thing to check before anything else, because the packaging instructions cover Windows and macOS only, and no Linux target appears anywhere in the file. The manifest hints at a wider Apple story than the sentence gives, since a package:mac-arm64 script sits next to the Intel-only mac packaging target, so Apple silicon is handled in the build system even though the support line speaks only of OSX versions. Contributors on other systems are not blocked from reading or editing the code, but the application does not support their platform, and the dependency notes even tell Windows users to install Git Bash, which suggests how narrow the tested surface is.
A hidden worker window owns the service layer
The architecture is the part of this project worth understanding before reading any code. The app is several windows that are, in the file's words, essential separate copies of the same JavaScript application running different pieces of the code and talking over Electron IPC. Three are named. The worker is a persistent invisible window running the entire services layer. The main window is what the user sees and it asks the worker to perform actions. The child window always runs in the background and surfaces panels such as Source Properties; it is kept alive because Electron windows can take several seconds to initialize. Beyond those there may be many more JavaScript runtime processes depending on use, for Apps, embedded webviews, one-off windows like projectors and pop-outs. During development, the main window's titlebar lights up red when an exception occurs in any window, which is the cheapest way to notice a crash in one of the copies you cannot see.
Calling a service synchronously is the pattern being removed
Because so much of the app communicates between windows, the file asks contributors to use asynchronous IPC wherever possible, and shows the rewrite in one line pair. The synchronous form is `StreamingService.toggleStreaming()`. The asynchronous form is `StreamingService.actions.toggleStreaming()`. Moving a call behind actions changes its type on purpose: the return type becomes void automatically, since actions are unable to return values. Reading data follows a different path again, through views, which execute in-window and are backed by the vuex data store, and that store is replicated across windows. The practical consequence for anyone touching this code is that a synchronous call is not just slower, it is out of policy, and a component that needs a value from a service should subscribe to a view rather than ask for it and wait.
Vue components are being retired in favour of React hooks
The interface layer is mid-migration and the rules are stated as rules, not aspirations. The file says the project is in the process of migrating from Vue to React, that many components of both frameworks currently exist in the codebase, that all new components should be written in React, and that major non-trivial changes to existing Vue components should be accompanied by a rewrite to React. That last clause is the one with teeth: a substantial edit to a Vue component is expected to delete it. React usage is narrowed further, since the project uses functional components exclusively and relies on the hooks API for component state and lifecycle, so there are no class components and no lifecycle methods to reach for. A contributor who opens a random component file has a reasonable chance of finding Vue, and the migration status is the reason.
Native C++ modules arrive as prebuilt binaries
The dependency story has one unusual element. Streamlabs Desktop uses several native C++ modules that live as npm modules in separate repositories, and Yarn installs them as prebuilt binaries, so if you are not working on those modules themselves there is nothing extra to do. The README is explicit that the prebuilt path is what a normal contributor gets. Alongside it there is a partial strict null check migration: the manifest defines compile:strictnulls and watch:strictnulls targets that set SLOBS_STRICT_NULLS=true, and a strict-null-check-files directory sits at the root. Webpack itself is run through a wrapper that raises the Node heap to 6144 megabytes, which is a fair hint about how large the bundle graph is.
Four commands get you from clone to running window
The development loop is short:
yarn install
yarn compile
yarn start`yarn compile` runs a clear step, compiles the updater with tsc, then drives webpack through the dev config; `yarn watch` does the same in watch mode instead. Yarn is yarn modern, the berry generation, with its version checked into version control alongside a .yarn directory and a .yarnrc.yml, and the file suggests installing the CLI with `npm install -g yarn`. Node is needed for installing packages and running scripts, and the latest LTS release is what it asks for. Some scripts assume a bash-like environment, so Windows contributors are pointed at Git Bash, which ships with Git for Windows, while the default shell on macOS is said to be fine.
Environment variables are the supported escape hatches
Five variables exist to force development behaviour that would otherwise be production-only. SLOBS_FORCE_AUTO_UPDATE runs the auto-updater outside production, SLOBS_CACHE_DIR moves the user data cache directory, SLOBS_DISABLE_MAIN_LOGGING turns off JavaScript logging in the main process, SLOBS_REPORT_TO_SENTRY sends errors to Sentry from a dev environment, and SLOBS_PRODUCTION_DEBUG opens the developer tools when the app starts. Two more appear in the packaging section, SLOBS_NO_SIGN and SLOBS_NO_NOTARIZE, which skip signing and notarization. Read together, they describe an application whose production behaviours are otherwise unreachable in a dev checkout, and they are the reason you can exercise the updater locally without waiting for a release channel.
Packaging needs certificates, and translations do not come from GitHub
Two policies close the file. Packaging runs `yarn package` for Windows and `yarn package:mac` for macOS, and both require code signing certificates to be present in the environment, with a valid Apple developer account additionally needed for notarization of the macOS package. That is why the two skip variables exist: a contributor can produce an unsigned build for testing, but a distributable build is gated on credentials the project does not hand out. Translation is the other policy. Translations submitted to GitHub are not accepted, because a professional translation team manages them elsewhere, which the crowdin.yml file at the repository root reflects. Contributions are welcome, but every contributor is asked to sign a Contributor License Agreement before code is merged, and no promise is made that external pull requests will be merged.
Editorial conclusion
Streamlabs Desktop suits a contributor who can work on macOS or Windows and wants to read a real multi-window Electron codebase with strict conventions about IPC, component style and packaging. It suits nobody on Linux, since the file names no Linux target even though the scripts assume a bash-like shell, and it is a poor base for anything other than a contribution, because the CLA requirement and the translation policy both route changes through the company. Before you start, check four things: your platform against the macOS 10.14+ and 64-bit Windows statement, whether the yarn version checked into the repository matches the one you have, whether a strict null check build is part of your workflow given the compile:strictnulls target, and whether you have signing certificates and an Apple developer account if you intend to produce an installable package rather than just run yarn start.
Frequently asked questions
How do I build and run Streamlabs Desktop from source?
Run `yarn install`, then `yarn compile` to build the assets with webpack, and `yarn start` to launch the app; `yarn watch` rebuilds on change instead. You need Node on a recent LTS release, yarn modern with its version checked into the repository, and a bash-like shell, which on Windows means Git Bash.
Which platforms does Streamlabs Desktop run on?
The file states that the application currently only supports OSX 10.14+ and 64-bit Windows. No Linux target is documented, although the manifest defines a separate mac-arm64 packaging script alongside the Intel one.
Why does Streamlabs Desktop use several windows?
The windows are separate copies of the same JavaScript app running different parts of the code and communicating over Electron IPC: a hidden worker window runs the whole services layer, the main window asks it to perform actions, and a child window is kept running in the background because Electron windows can take several seconds to initialize.
How should Streamlabs Desktop code talk to services?
Asynchronously. The file rewrites the synchronous `StreamingService.toggleStreaming()` as `StreamingService.actions.toggleStreaming()`, whose return type becomes void because actions cannot return values, and it says values are best read through views, which run in-window and are backed by the vuex store replicated across windows.
Can I contribute translations to Streamlabs Desktop?
Not through GitHub. The file says translations submitted there are not accepted because a professional translation team manages translations elsewhere, and the repository carries a crowdin.yml at its root. Code contributions are accepted, but contributors are asked to sign a Contributor License Agreement before merging.
What do I need to package a Streamlabs Desktop build?
Code signing certificates present in the environment, and for macOS a valid Apple developer account so the package can be notarized. The commands are `yarn package` for Windows and `yarn package:mac` for macOS, and SLOBS_NO_SIGN and SLOBS_NO_NOTARIZE skip those steps for local builds.
Official sources
Add this badge to your README
If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.
[](https://hysenlabs.com/projects/streamlabs-desktop)Star history chart for your README
[](https://hysenlabs.com/projects/streamlabs-desktop)Was this useful?