Install Instructions

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:

  • Requirements for building OBS on windows

    • Development packages of FFmpeg, x264, cURL, and mbedTLS.
    • Pre-built windows dependencies for VS2017/VS2019 can be found here:
    • Qt5 (Grab the MSVC package for your version of Visual Studio)
    • We currently deploy with 5.10.1, which is no longer available from Qt. A download is provided here.
    • Windows version of cmake (3.16 or higher, latest preferred)
    • Windows version of git (git binaries must exist in path)
    • Visual Studio 2019 (recommended)
    • Windows 10 SDK (minimum 10.0.19041.0). Latest SDK
  • Installation Procedure

    • Clone the repository and submodules:

      git clone --recursive https://github.com/obsproject/obs-studio.git

    • If you do not know what submodules are, or you are not using git from the command line, PLEASE make sure to fetch the submodules too.

    • Create one or more of the following subdirectories within the cloned repository for building: release, debug, and build (suffixed with or without 32/64 to specify architecture). They are excluded from the repo in .gitignore for the sake of building, so they are safe to create an use within the repository base directory.

    • Run cmake-gui, and set the following fields:
    • In "where is the source code", enter in the repo directory (example: D:/obs).
    • In "where to build the binaries", enter the repo directory path with the 'build' subdirectory (example: D:/obs/build).

    • Set the following variables in cmake-gui (alternatively, you can set them as Windows Environment Variables):
    • Required
      • DepsPath (Path to the include for all dependencies, not including Qt.).
      • An example path if you extracted the dependencies .zip to c:\obs-deps would be:
        • c:\obs-deps\win32
        • c:\obs-deps\win64
      • If you wish to specify both 32 and 64 bit dependencies (for multi-arch building), you can use DepsPath32 and DepsPath64 to their respective include folders.
      • QTDIR (Path to Qt build base directory. GUI is built by default. Set the cmake boolean variable DISABLE_UI to TRUE if you don't want the GUI and this is no longer required. Can be optionally suffixed with 32 or 64 to specify target arch).
      • NOTE: Make sure to download Qt prebuilt components for your version of MSVC (32 or 64 bit).
      • Example Qt directories you would use here if you installed Qt to D:\Qt would usually look something like this:
        • (32bit) QTDIR=D:\Qt\5.10.1\msvc2017
        • (64bit) QTDIR64=D:\Qt\5.10.1\msvc2017_64
    • Optional (If these share the same directory as DepsPath, they do not need to be individually specified.)

      • FFmpegPath (Path to just FFmpeg include directory.)
      • x264Path (Path to just x264 include directory.)
      • curlPath (Path to just cURL include directory.)
    • INFORMATIONAL NOTE: Search paths and search order for base dependency library/binary files, relative to their include directories:

      Library files

      • ../lib
      • ../lib32 (if 32bit)
      • ../lib64 (if 64bit)
      • ./lib
      • ./lib32 (if 32bit)
      • ./lib64 (if 64bit)

      Binary files:

      • ../bin
      • ../bin32 (if 32bit)
      • ../bin64 (if 64bit)
      • ./bin
      • ./bin32 (if 32bit)
      • ./bin64 (if 64bit)
    • In cmake-gui, press 'Configure' and select the generator that fits to your installed VS Version:
      Visual Studio 16 2019, or their 64bit equivalents if you want to build the 64bit version of OBS

      • NOTE: If you need to change your dependencies from a build already configured, you will need to uncheck COPIED_DEPENDENCIES and run Configure again.
    • If you did not set up Environment Variables earlier you can now configure the DepsPath and if necessary the x264, ffmpeg and curl path in the cmake-gui.

    • In cmake-gui, press 'Generate' to generate Visual Studio project files in the 'build' subdirectory.

    • Open obs-studio.sln from the subdirectory you specified under "where to build the binaries" (e.g. D:/obs/build) in Visual Studio (or click the Open Project button from the cmake-gui in 3.7+).

    • The project should now be ready to build and run. All required dependencies should be copied on compile and it should be a fully functional build environment. The output is built in the 'rundir/[build type]' directory of your 'build' subdirectory.
  • Integrating clang-format into Visual Studio
    • clang-format is required for pull requests, and OBS uses a newer version than the one VS2017 ships with.
    • Download and install LLVM 8.0.0
    • Run VS, and go to Tools -> Options...
    • Text Editor -> C/C++ -> Code Style -> Formatting -> General
      • Enable "Use custom clang-format.exe" and enter the file name. For example:
      • C:\Program Files\LLVM\bin\clang-format.exe
    • The default command for formatting a document (Edit.FormatDocument) is Ctrl+K, Ctrl+D.

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.

Official macOS builds are available again as of 18.0.1.


macOS Build Directions

  • Clone the repository and submodules:

    git clone --recursive https://github.com/obsproject/obs-studio.git
  • If you do not know what submodules are, or you are not using git from the command line, PLEASE make sure to fetch the submodules too.

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:

  • To build OBS as-is with full browser-source support, simply run ./CI/full-build-macos.sh from the checkout directory (The script will take care of downloading all necessary dependencies).
  • To create an app-bundle after building OBS, run the script with the -b flag: ./CI/full-build-macos.sh -b
  • To create a disk image after building OBS, run the script with the -p flag: ./CI/full-build-macos.sh -b -p
  • To notarize an app bundle after building and bundling OBS, run the script with the -n flag: ./CI/full-build-macos.sh -b -n
  • To create an app-bundle without building OBS again, run the script with the -s flag: ./CI/full-build-macos.sh -s -b

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):

  • FFmpeg
  • x264
  • cmake
  • freetype
  • mbedtls
  • swig
  • Qt5

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).

  • When using obs-deps, extract both archives from the macOS release to /tmp/obsdeps to assure compatibility with app bundling later (due to the way dylibs are identified and linked).
  • Create a build directory inside the obs-studio directory, change to it, then configure the project via cmake:

            cmake -DCMAKE_OSX_DEPLOYMENT_TARGET=10.13 -DQTDIR="/tmp/obsdeps" -DSWIGDIR="/tmp/obsdeps" -DDepsPath="/tmp/obsdeps" -DDISABLE_PYTHON=ON ..
  • Build OBS by running make

Configuring and Building

  • If not already handled by the Homebrew installation, install a current macOS platform SDK (only macOS 10.13 or newer is supported): xcode-select --install
  • Create a build directory inside the obs-studio directory, change to it, then configure the project via cmake:

            cmake -DCMAKE_OSX_DEPLOYMENT_TARGET=10.13 -DDISABLE_PYTHON=ON ..
  • NOTE: cmake might require additional parameters to find Qt5 libraries present on this system, this can either be provided via -DQTDIR="/usr/local/opt/qt" or setting an environment variable, e.g.: export QTDIR=/usr/local/opt/qt
  • Build OBS by running make
  • Run OBS from the /rundir/RelWithDebInfo/bin directory in your build directory, by running ./obs from a Terminal
  • NOTE: If you are running via command prompt, you must be in the 'bin' directory specified above, otherwise it will not be able to find its files relative to the binary.

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_BUILDcan be used, but must be configured first:

  • Select ALL_BUILD from available build schemes in Xcode, then press CMD+B to build the project at least once
  • Then select Edit Scheme... from the same menu.
  • Under the Info tab, click on the dropdown for Executable, then click on other
  • Navigate to the /rundir/debug/bin bin folder that the previous Xcode build process should have created and select the obs binary found there
  • Next switch to the Options tab and check the box to Use custom working directory and select the same /rundir/debug/bin directory in your Xcode build directory

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:

  • Build (but do not run) OBS with Xcode
  • Run BUILD_DIR="YOUR_XCODE_BUILD_DIR" BUILD_CONFIG="Debug" ../CI/full-build-macos.sh -d -s -b to bundle OBS build by Xcode, replace YOUR_XCODE_BUILD_DIR with the directory where you ran cmake to create the Xcode project
  • Next create a new Xcode project, select macOS as platform and Framework as type.
  • Give your project any arbitrary name and place it in any folder you like
  • With the new project open, click on your current build scheme in Xcode and select Edit Scheme...
  • For the Run step, go to the Info tab and select Other... in the dropdown for Executable
  • Browse to your OBS Xcode build directory and select the OBS.app application bundle created by the script

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 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 Installation

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

  • xserver-xorg version 1.18.4 or newer is recommended to avoid potential performance issues with certain features in OBS, such as the fullscreen projector.
  • FFmpeg is required. If you do not have the FFmpeg installed (if you're not sure, then you probably don't have it), you can get it with the following commands:

    sudo apt install ffmpeg
  • Then you can install OBS with the following commands, make sure you enabled the multiverse repo in Ubuntu's software center (NOTE: On newer versions of ubuntu adding a repository automatically apt updates.):

    sudo add-apt-repository ppa:obsproject/obs-studio
    sudo apt update
    sudo apt install obs-studio

Arch Linux Installation (Unofficial)

  • "Release" version is available on community repository:

    sudo pacman -S obs-studio
  • "Git" version is available on AUR

Manjaro Installation (Unofficial)

  • Graphical: search "obs-studio" on Pamac Manager or Octopi
  • Command-line: install it via pacman with the following command:

    sudo pacman -S obs-studio

Fedora Installation (Unofficial)

  • OBS Studio is included in RPM Fusion. If you do not have it configured (if you're not sure, then you probably don't have it), you can do so with the following command:

    sudo dnf install https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm https://download1.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm
  • Then you can install OBS with the following command (this pulls all dependencies, including NVENC-enabled ffmpeg):

    sudo dnf install obs-studio
  • For NVIDIA Hardware accelerated encoding make sure you have CUDA installed (in case of an older card, install xorg-x11-drv-nvidia-340xx-cuda instead):

    sudo dnf install xorg-x11-drv-nvidia-cuda

OpenMandriva Installation (Unofficial)

  • OBS Studio is included in OpenMandriva Lx3 non-free repository and in restricted repository for upcoming Lx4 release - available now as Cooker.

For OpenMandriva Lx3

  • Graphical: search and install "obs-studio" on "OpenMandriva Install and Remove Software" (Rpmdrake)
  • Command-line: install it as root (su or sudo) via terminal/konsole with the following command:

    urpmi obs-studio

For OpenMandriva Lx4

  • Graphical: search and install "obs-studio" on "OpenMandriva Software Management" (dnfdragora)
  • Command-line: install it as root (su or sudo) via terminal/konsole with the following command:

    dnf install obs-studio

openSUSE Installation (Unofficial)

  • The Packman repository contains the obs-studio package since it requires
    the fuller version of FFmpeg which is in Packman for legal reasons. If you
    do not already have the Packman repository add it as shown below.

  • It is recommended to set the priority for Packman lower so it takes
    precedence over base repositories (skip on Tumbleweed as included in initial command).

    sudo zypper mr --priority 90 packman
  • The Packman version of FFmpeg should be used for full codec support. To
    ensure any existing FFmpeg packages are switched to Packman versions
    execute the following before installing obs-studio.

    sudo zypper dup --repo packman
  • Install the obs-studio package.

    sudo zypper in obs-studio

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.

  • First make sure you have everything up-to-date.

    sudo apt-get update
  • FFmpeg is required. If you do not have the FFmpeg installed (if you're not sure, then you probably don't have it), you can get it with the following command (or compile it yourself):

    sudo apt-get install ffmpeg
  • Finally, install OBS Studio.

    sudo apt-get install obs-studio
  • or(but need install Spark Store)

    sudo apt install com.obsproject.studio

Debian 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.

  • First make sure you have everything up-to-date.

    sudo apt update
  • FFmpeg is required. If you do not have the FFmpeg installed (if you're not sure, then you probably don't have it), you can get it with the following command (or compile it yourself):

    sudo apt install ffmpeg
  • Finally, install OBS Studio.

    sudo apt install obs-studio

Void Installation (Unofficial)

  • First make sure your repositories are up-to-date. OBS is available on the multilib repos if you need the 32-bit build.

    sudo xbps-install -S
  • Then just install OBS Studio. Any missing dependencies will be installed automatically.

    • If it refuses to install, try running sudo xbps-install -Su to update everything first.

      sudo xbps-install obs

Though unofficial, the package is actively maintained and functional!


snappy Installation (Unofficial)

  • If you haven't already, install snapd (ignore the Support Overview which is outdated).

  • Install OBS Studio.

    sudo snap install obs-studio

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/Fedora-based Build Directions

  • Get RPM fusion at http://rpmfusion.org/Configuration/ (Nux Desktop is an alternative that may include better packages for RHEL/CentOS 7)
  • Get the required packages:

    sudo yum install \
           make \
           gcc \
           gcc-c++ \
           gcc-objc \
           cmake \
           git \
           libX11-devel \
           mesa-libGL-devel \
           libv4l-devel \
           pulseaudio-libs-devel \
           libspeexdsp-devel \
           x264-devel \
           freetype-devel \
           fontconfig-devel \
           libXcomposite-devel \
           libXinerama-devel \
           qt5-qtbase-devel \
           qt5-qtx11extras-devel \
           qt5-qtsvg-devel \
           libcurl-devel \
           systemd-devel \
           ffmpeg \
           ffmpeg-devel \
           luajit-devel \
           python3-devel \
           mbedtls \
           mbedtls-devel \
           swig
  • Building and installing OBS:

  • By default obs installs libraries in /usr/local/lib. To make sure that the loader can find them there, create a file /etc/ld.so.conf.d/local.conf with the single line

    /usr/local/lib

    and then run

    sudo ldconfig

Debian-based Build Directions

  • Get the required packages:

    sudo apt-get install \
               build-essential \
               checkinstall \
               cmake \
               git \
               libmbedtls-dev \
               libasound2-dev \
               libavcodec-dev \
               libavdevice-dev \
               libavfilter-dev \
               libavformat-dev \
               libavutil-dev \
               libcurl4-openssl-dev \
               libfdk-aac-dev \
               libfontconfig-dev \
               libfreetype6-dev \
               libgl1-mesa-dev \
               libjack-jackd2-dev \
               libjansson-dev \
               libluajit-5.1-dev \
               libpulse-dev \
               libqt5x11extras5-dev \
               libspeexdsp-dev \
               libswresample-dev \
               libswscale-dev \
               libudev-dev \
               libv4l-dev \
               libvlc-dev \
               libx11-dev \
               libx264-dev \
               libxcb-shm0-dev \
               libxcb-xinerama0-dev \
               libxcomposite-dev \
               libxinerama-dev \
               pkg-config \
               python3-dev \
               qtbase5-dev \
               libqt5svg5-dev \
               swig \
               libxcb-randr0-dev \
               libxcb-xfixes0-dev \
               libx11-xcb-dev \
               libxcb1-dev \
               libxss-dev
  • Building and installing OBS:

    • If building with browser source:

      wget https://cdn-fastly.obsproject.com/downloads/cef_binary_3770_linux64.tar.bz2
      tar -xjf ./cef_binary_3770_linux64.tar.bz2
      git clone --recursive https://github.com/obsproject/obs-studio.git
      cd obs-studio
      mkdir build && cd build
      cmake -DUNIX_STRUCTURE=1 -DCMAKE_INSTALL_PREFIX=/usr -DBUILD_BROWSER=ON -DCEF_ROOT_DIR="../../cef_binary_3770_linux64" ..
      make -j4
      sudo checkinstall --default --pkgname=obs-studio --fstrans=no --backup=no --pkgversion="$(date +%Y%m%d)-git" --deldoc=yes

    • If building without browser source

      git clone --recursive https://github.com/obsproject/obs-studio.git
      cd obs-studio
      mkdir build && cd build
      cmake -DUNIX_STRUCTURE=1 -DCMAKE_INSTALL_PREFIX=/usr ..
      make -j4
      sudo checkinstall --default --pkgname=obs-studio --fstrans=no --backup=no --pkgversion="$(date +%Y%m%d)-git" --deldoc=yes


openSUSE Build Directions

  • See openSUSE installation instructions (above) for details on adding Packman repository.
  • Install build dependencies:

    sudo zypper in cmake \
                 fontconfig-devel \
                 freetype2-devel \
                 gcc \
                 gcc-c++ \
                 libcurl-devel \
                 ffmpeg2-devel \
                 libjansson-devel \
                 libpulse-devel \
                 libspeexdsp-devel \
                 libqt5-qtbase-devel \
                 libqt5-qtx11extras-devel \
                 libudev-devel \
                 libv4l-devel \
                 libXcomposite-devel \
                 libXinerama-devel \
                 libXrandr-devel \
                 luajit-devel \
                 mbedtls \
                 swig \
                 python3-devel \
                 libxss-dev
  • Building and installing OBS:


Linux portable mode (all distros)

  • Please note that you need to install the build dependencies for your repo before following this steps. See above.
  • You can build in portable mode on Linux, which installs all the files to an isolated directory.

  • After that you should have a portable install in ~/obs-studio-portable. Change to bin/64bit or bin/32bit and then simply run: ./obs

FreeBSD

FreeBSD Installation (Unofficial)

  • Install OBS Studio:

    pkg install obs-studio

FreeBSD Build Directions

  • The easiest way to build OBS Studio from source is to use the FreeBSD Ports and modify the multimedia/obs-studio port to suite your needs.
  • First you have to set up the ports infrastructure on your system. See the related chapter in the FreeBSD Handbook.
  • Once you've got your ports tree at /usr/ports you may edit the multimedia/obs-studio port to your liking. Then, you may build and install the port with:

    cd /usr/ports/multimedia/obs-studio
    make install clean