Skip to content

Installation

Xaymar edited this page Mar 28, 2021 · 81 revisions

If you encounter Issues while your System does not meet the minimum System Requirements, we reserve the right to ignore you as you have also ignored our posted minimum System Requirements. Please do your utmost best to read the Frequently Asked Questions, as well as the System Requirements!

Conflicting Software

  • Windows Defender: Due to the binaries not being signed, Windows Defender warns about running them. You can bypass this warning by clicking "More Info" and then "Run anyway".
  • Norton/Avira/Avast AntiVirus: May not like the use of InnoSetup and prevents writing files, resulting in corrupted installations. Please ensure that you temporarily disable your AntiVirus or whitelist the installer file.

Automated Installation Windows MacOS

Windows Windows

  1. Download the .exe Installer of the latest Production or Testing release of your choice for Windows.
  2. Double-Click the downloaded file to run the Installer.
    • If Microsoft SmartScreen is Enabled, you will encounter a pop-up titled "Windows protected your PC". This pop-up informs you that the executable you just downloaded is unsigned, and running it comes at no warranty from Microsoft. To continue past it, click More info and then Run anyway.
    • If Windows Defender is active, you might encounter another pop-up titled "Open File - Security Warning". This pop-up informs you that the executable you just tried to run is unsigned. To continue click Run.
    • Finally if UAC is Enabled, you will encounter another pop-up titled User Account Control. This pop-up informs you that the executable you wanted to run requires Administrator rights to modify the System. The Installer requires Administrator rights due to the default location of plug-ins for OBS Studio being located in a protected directory. In other to continue, click Yes.
  3. Follow the Installer as it guides you through the installation.

MacOS MacOS

  1. Download the .pkg Installer of the latest Production or Testing release of your choice for MacOS.
  2. Option-Click on the .pkg file, then select Open With and then select Installer.
    • This will cause a window to appear, asking you to confirm that you want to trust this file. To continue with the guide, you have to select Open.
  3. An Installer should now appear, which will guide you through the installation process.

Manual Installation Windows Linux MacOS

The Zip and 7Z archives allow for easy portable installs, and technically even allow for a plugin manager to easily load plugins from arbitrary directories.

Windows Windows

  1. Download the latest Production or Testing release of your choice for Windows.
  2. If Microsoft SmartScreen complains, select More Info and then Run anyway.
  3. Extract the archive to where you installed or extracted OBS Studio to, which by default is C:\Program Files\obs-studio.
  4. Done, you can now launch OBS Studio and StreamFX should load.

Linux Linux (Debian, Ubuntu, ...)

  1. Download the latest Production or Testing release of your choice for Linux.
  2. Extract the archive to ~/.config/obs-studio/.
  3. Done, you can now launch OBS Studio and StreamFX should load.

MacOS MacOS

  1. Download the latest Production or Testing release of your choice for MacOS.
  2. Open the recently downloaded archive and extract its contents to /Library/Application Support/obs-studio/plugins/StreamFX.
    • Technically the actual directory to extract to is /Library/Application Support/obs-studio/plugins, but for some unknown reason Apple decides to hide the top level directory in archives.
  3. Open OBS Studio and wait for it to show a dialog about loading StreamFX.so, click cancel, then quit OBS Studio.
  4. Open Finder and go to /Library/Application Support/obs-studio/plugins/StreamFX/bin.
  5. Right click (Control-Click) on StreamFX.so and select Open, which should show a window about unverified developer/untrusted binaries.
  6. In the window that appears, select Open in order to allow the file to be loaded by other applications.
    • If the window does not appear, you have to manually tell MacOS that OBS Studio will open it. This can be done with the Open With -> Other... menu, where you just select OBS and hit ok.
  7. Done, you can now launch OBS Studio and StreamFX should load.

If all other options failed, you can always attempt to build the project from source. While this option is much more difficult for beginners, it allows you to mess with many more things. Perhaps it is your entry into a world of wondering why the code doesn't compile despite it looking correct, and parsing cryptic errors and warnings.

Clone this wiki locally