Install Instructions - obsproject/obs-studio Wiki

If you want to develop for OBS, please visit our Discord and get to know the devs or have questions answered!

Also, if there is something in this guide you want to change/improve on, it is recommended that you talk about it with the devs in Discord or IRC first.

Please note that any install directions/packages for Linux/FreeBSD distributions listed as Unofficial means that they are community provided, and any support for those packages should be directed at the appropriate distro/package maintainers.


Table of Contents:


Windows

Windows Install Directions:

Pre-built Windows versions can be found here: https://github.com/obsproject/obs-studio/releases/

The full .exe installer and .zip contains OBS Studio 32bit, 64bit, Browser Source, and Intel® RealSense™ plugin. You will be prompted during install for the Browser Source and RealSense plugin to be installed if using the .exe installer, otherwise the components are included in the .zip.

The small .exe installer contains the base OBS Studio 32bit, 64bit, Intel® RealSense™ plugin, but does not contain the Browser Source plugin.

NOTE: If using the .zip method for either the full or small install and installing to a non-standard program location (i.e. outside Program Files), you will need to add the security group ALL APPLICATION PACKAGES to have full control over the main OBS Studio directory and sub-directories. Certain features may not function properly without these security rights (primarily, the ability to use game capture on UWP apps).


Windows Build Directions:

macOS

macOS Install Directions

Pre-built macOS versions can be found here: https://github.com/obsproject/obs-studio/releases

Simply run the installer and follow the on-screen directions to install OBS Studio.


macOS Build Directions

macOS Full Build Script

To get a self-built OBS up and running, a default build and packaging script is provided. This script only requires Homebrew (https://brew.sh) to be installed on the build system already:

The last option is helpful if custom cmake flags have been used, but a proper app bundle is desired.

macOS Custom Builds

Custom build configurations require a set of dependencies to be installed on the build system. Some dependencies need to be installed via Homebrew (https://brew.sh):

If you need SRT support, either use FFmpeg provided by obs-deps or install FFmpeg from a custom tap instead of the default homebrew FFmpeg:

brew tap homebrew-ffmpeg/ffmpeg
brew install homebrew-ffmpeg/ffmpeg/ffmpeg --with-srt

Pre-Built Dependencies

These dependencies are also available via obs-deps (https://github.com/obsproject/obs-deps) as pre-compiled binaries, which are assured to be compatible with current OBS code (as OBS is built against specific versions of some packages while Homebrew delivers most recent stable builds).

Configuring and Building


macOS Xcode Project

To create an Xcode project for OBS, cmake must be run with additional flags. Follow the build instructions above to create a working configuration setup, then add -G Xcode to the cmake command, e.g.:

cmake -DCMAKE_OSX_DEPLOYMENT_TARGET=10.13 -DDISABLE_PYTHON=ON -G Xcode ..

This will create an obs-studio.xcodeproj project file in the build directory as well as Xcode project files for all build dependencies. To build a full macOS build, the build target ALL_BUILD can be used, but must be configured first:

NOTE: When running OBS directly from Xcode be aware that browser sources will not be available (as CEF requires to be run as part of an application bundle in macOS) and accessing the webcam will lead to a crash (as macOS requires a permission prompt text set in an application bundle's Info.plist which is, of course, not available).

To debug OBS on macOS with all plugins and modules loaded, follow these steps:

You can now run OBS with Xcode directly attached as debugger. You can debug the visual stack as well as trace crashes and set breakpoints.

NOTE: Breakpoints set in the actual Xcode project do not carry over to this "helper" project and vice versa.

Linux

Any installation directions marked Unofficial are not maintained by the OBS Studio author and may not provide all the features and/or be up to date or stable.

NOTE: OpenGL 3.3 or later is required to use OBS Studio on Linux. You can check what version of OpenGL is supported by your system by typing glxinfo | grep "OpenGL" on Terminal.

Linux Install Directions

Ubuntu/Mint Installation

Please note that OBS Studio is not fully working on Chrome OS and features like Screen and Window Capture do not work.

sudo apt install v4l2loopback-dkms

Arch Linux Installation (Unofficial)


Manjaro Installation (Unofficial)


Fedora Installation (Unofficial)


OpenMandriva Installation (Unofficial)

For OpenMandriva Lx3

For OpenMandriva Lx4


Solus Installation (Unofficial)


openSUSE Installation (Unofficial)

Links:


Gentoo Installation (Unofficial)

Command-line: can be installed using portage by the following command:

sudo emerge media-video/obs-studio

See https://packages.gentoo.org/packages/media-video/obs-studio for available versions and more information.


NixOS Installation (Unofficial)

Command-line: can be installed by the following command:

nix-env -i obs-studio

See https://nixos.org/wiki/OBS for further instructions


UOS/Deepin Installation (Unofficial)

UOS/Deepin 20 or newer is required.


Debian/LMDE Installation (Unofficial)

Debian 9.0 or newer is required.
Please note that OBS Studio is not fully working on Chrome OS and features like Screen and Window Capture do not work.

Also note that as of 2021-06-13, this package is the outdated 0.0.1 version. It should still work, but won't have all new improvements. Build from source to get the newest version.


Void Installation (Unofficial)


snappy Installation (Unofficial)


Linux Build Directions

Note: as of May 1, 2019, Facebook live now mandates the use of RTMPS. That functionality requires your distro's mbed TLS package, which obs-studio/cmake/Modules/FindMbedTLS.cmake script searches for at compile time.

Note: Do not use the GitHub source .tar as it does not include all the required source files. Always use the appropriate Git tag with the associated submodules.

Red Hat-based Build Directions

Fedora Build Directions

sudo dnf install \
       cmake \
       ffmpeg-devel \
       fontconfig-devel \
       freetype-devel \
       gcc \
       gcc-c++ \
       gcc-objc \
       git \
       glib2-devel \
       libcurl-devel \
       libdrm-devel \
       libglvnd-devel \
       libv4l-devel \
       libX11-devel \
       libXcomposite-devel \
       libXdamage \
       libXinerama-devel \
       luajit-devel \
       make \
       mbedtls-devel \
       pipewire-devel \
       pulseaudio-libs-devel \
       python3-devel \
       qt5-qtbase-devel \
       qt5-qtbase-private-devel \
       qt5-qtsvg-devel \
       qt5-qtwayland-devel \
       qt5-qtx11extras-devel \
       speexdsp-devel \
       swig \
       systemd-devel \
       vlc-devel \
       wayland-devel \
       x264-devel

Debian-based Build Directions


openSUSE Build Directions


Linux portable mode (all distros)

FreeBSD

FreeBSD Installation (Unofficial)


FreeBSD Build Directions