Go to file
Michael Fabian 'Xaymar' Dirks c084a0bfd0 source-mirror: Use a private scene source for rendering 2018-11-07 14:44:07 +01:00
.github/ISSUE_TEMPLATE Add Issue Templates 2018-10-05 20:40:52 +02:00
ci project: Update project URL 2018-09-26 01:22:54 +02:00
cmake cmake: Add Template and Inline Suppression support for CppCheck 2018-09-27 02:43:28 +02:00
data filter-blur: Fix Mask Type and split Color into Color and Alpha 2018-10-01 00:57:22 +02:00
source source-mirror: Use a private scene source for rendering 2018-11-07 14:44:07 +01:00
tools tools: Improve make-solutions.bat 2018-04-29 03:42:15 +02:00
.clang-format project: Add clang-format support 2018-09-26 01:15:53 +02:00
.editorconfig project: Revert to 4-wide tab 2018-09-27 02:44:56 +02:00
.gitignore project: Remove AMD text from gitignore 2017-08-19 23:32:18 +02:00
CMakeLists.txt cmake: Add obs-source and obs-tools source 2018-11-07 14:44:06 +01:00
LICENSE GPLv2 and gitignore 2017-06-28 23:20:50 +02:00
README.md project: Add Windows and Linux build status from CI 2018-04-26 13:07:17 +02:00
appveyor.yml ci: Remove unused cache entry 2018-04-24 12:40:22 +02:00

README.md

OBS Stream Effects

Bring your stream to life with more modern effects! Stream Effects adds several much needed features to OBS Studio, such as real time Blur and 3D Transform. Now you can blur out sources you think may be questionable, add sick 3D effects or recreate the Heroes of the Storm displacement overlay with the Displacement filter.

Build Status

Windows Linux & Mac
AppVeyor Status Build Status

Features & Stuff

New Filters

  • 3D Transform
  • Blur
  • Displacment

New Transitions

Building the Project

Building the project is fairly easy and relies on CMake to ease the process.

Prerequisites

  • Visual Studio 2013, 2015 or 2017
  • CMake
  • A built version of obs-studio

Configuration

The project supports both command line and GUI versions of cmake, these are the parameters than can be configured:

  • PATH_OBSStudio: Path to the root of a completely built obs-studio version.
  • INSTALL_DIR: Where the INSTALL target installs files to.
  • PACKAGE_PREFIX: The prefix for the PACKAGE_* generated files.
  • PACKAGE_SUFFIX: The suffix for the PACKAGE_* generated files, defaults to the version number.

Building

Building is simply handled by CMake. If you generated an IDE project, just use the IDE provided options for building.

Installing

You can directly install files into an existing obs-studio installation or put them in a separate directory for later packaging and releasing. Simply point INSTALL_DIR to the directory where you want the files to be installed to and then run the INSTALL target (which will also build the project if it hasn't been built yet).

Packaging

Packaging has two options, 7zip and zip. Simply run the targets PACKAGE_ZIP and/or PACKAGE_7ZIP and you will have a build that you can distribute.

Continuous Integration

To ease detection of bad commits and PRs, CI support has been added to the project. Currently the following CI providers are supported:

  • AppVeyor (for Windows on any support Visual Studio version)