cwoodyard/obs-studio

OBS Studio - Free and open source software for live streaming and screen recording

OBS Studio <https://obsproject.com>

What is OBS Studio?

OBS Studio is software designed for capturing, compositing, encoding, recording, and streaming video content, efficiently.

It's distributed under the GNU General Public License v2 (or any later version) - see the accompanying COPYING file for more details.

Quick Links

• Website: https://obsproject.com
• Help/Documentation/Guides: https://github.com/obsproject/obs-studio/wiki
• Forums: https://obsproject.com/forum/
• Build Instructions: https://github.com/obsproject/obs-studio/wiki/Install-Instructions
• Developer/API Documentation: https://obsproject.com/docs
• Donating/backing/sponsoring: https://obsproject.com/contribute
• Bug Tracker: https://github.com/obsproject/obs-studio/issues

Building from source

Clone the repository and submodules

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

Windows:

Install the following prerequisites:

1. Qt 5.14.1
2. Cmake
3. Pre-built windows dependencies for VS2017 https://obsproject.com/downloads/dependencies2017.zip
4. Visual Studio 2019
5. LLVM
6. Embedded chrome browser library version 08/29/2018 - CEF 3.3440.1806.g65046b7 / Chromium 68.0.3440.106

After installing the prerequisites .Create the following environment variables:

1. QTDIR - Path pointing Qt 5.14.1 msvc2017_64 folder
2. obsInstallerTempDir - Empty directory path
3. DepsPath - Path to pre-built windows dependencies win64/include
4. LIBCAFFEINE_DIR - Path to prebuilt libcaffeine folder
5. CEF_ROOT_DIR - Path to the embedded chrome browser library

Run the automated build script: build.bat [OPTION]

Option	Usage
-help	To display the supported options.
-check	To verify project prerequisites are set.
-build	To build 64 bit version of obs-studio.
-package	To build package.

Mac:

Install following prerequisites:

• Homebrew
• Qt

Build steps:

Open Terminal

1. Install FFmpeg

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

2. Set environment variable for Qt

   export QTDIR="path/to/Qt"
   
   export DYLID_FRAMEWORK_PATH="path/to/Qt/5.14.1/clang_64/lib"
   

3. Install cmake

   brew install cmake
   

4. Change directory obs-studio directory

   mkdir build
   
   cd build
   
   cmake .. & make
   

5. After it built successfully then run the app

   cd rundir/RelWithDebInfo/bin
   
   ./obs
   

Contributing

• If you would like to help fund or sponsor the project, you can do so via Patreon, OpenCollective, or PayPal. See our contribute page for more information.
• If you wish to contribute code to the project, please make sure to read the coding and commit guidelines: https://github.com/obsproject/obs-studio/blob/master/CONTRIBUTING.rst
• Developer/API documentation can be found here: https://obsproject.com/docs
• If you wish to contribute translations, do not submit pull requests. Instead, please use Crowdin. For more information read this thread: https://obsproject.com/forum/threads/how-to-contribute-translations-for-obs.16327/
• Other ways to contribute are by helping people out with support on our forums or in our community chat. Please limit support to topics you fully understand -- bad advice is worse than no advice. When it comes to something that you don't fully know or understand, please defer to the official help or official channels.