streamlabs /desktop

Free and open source streaming software built on OBS and Electron.

★ 4,875⑂ 690👁 118⑃ 6,388● 0▤ 0
TypeScriptGPL-3.0Created 2017-10-26streamlabs.com
+1
日增长
4,875
stars
690
forks
118
watchers
6,388
prs
0
issues
0
releases

README

Streamlabs Desktop



Simple, powerful, and efficient live streaming software built on Electron and OBS.

!Streamlabs Desktop

This application currently only supports OSX 10.14+ and 64-bit Windows.

 Dependencies

 Node.js

Node is required for installing npm packages and for running
various scripts. We recommend the latest LTS release.

https://nodejs.org

 Yarn

We use Yarn as our package manager. We use yarn modern (berry) with
the yarn version checked in to version control. To get the yarn CLI,
we currently recommend installing it with npm:


npm install -g yarn


 Bash

Some of our scripts assume a bash-like environment. On Windows, we recommend
using Git Bash, which is included with Git for Windows. On macOS, the
default shell should work fine.

 Native Modules

Streamlabs Desktop uses several native C++ modules. These are NPM modules
that live in separate repositories, and are automatically installed as prebuilt
binaries by Yarn. If you are not doing any development on these native modules,
no additional action is required to install native modules.

 Installation

Install all node modules via yarn:


yarn install


Then, compile assets with webpack:


yarn compile


Alternatively, you can watch for changes to app files:


yarn watch


 Starting

You can start the app by running:


yarn start


 Environment Variables

These variables can be used in development to force certain behavior.

SLOBS_FORCE_AUTO_UPDATE: Force the auto-updater to run in development. Normally
this would only run in production.

SLOBS_CACHE_DIR: Force a different location for the user data cache directory.

SLOBS_DISABLE_MAIN_LOGGING: Disable javascript logging in the main process.

SLOBS_REPORT_TO_SENTRY: Report errors to sentry in the dev environment

SLOBS_PRODUCTION_DEBUG: Forces dev tools to open when the app starts

 Development

You can open dev tools by clicking the  button on the sidebar.
In the development environment, the titlebar of the main window will
light up red when an exception occurs in any window.

Our app is comprised of several windows, which are essential separate
copies of the same Javascript app, which are running different pieces
of the code and communicating via Electron IPC.

worker - This is a persistent invisible window that runs our entire
services layer.

main - This is the main window of the application. It communicates
with the worker window to perform actions.

child - This window is always running in the background, and appears
to show windows like Source Properties. It stays always running because
Electron windows can take several seconds to initialize, so we keep it
ready in the background.

There are potentially many other JS runtime processes that can be running
depending on use, for features like Apps, embedded webviews, one-off windows
like projectors, pop-outs etc.

 Sync / Async

Given the heavy reliance on interprocess communication in our application,
we strongly recommend using asynchronous IPC whenever possible. When
a

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON