Installation

Please make sure to read the FAQ!

It covers many repeatedly asked questions and can save you some time, especially when there are few people helping voluntarily. Additionally, you should make sure that the build you chose supports the OBS Studio version you are trying to install it on.

Official Releases

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.

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.
3. You will now be asked if you wish to install StreamFX for "all users" (static installation) or "me only" (portable installation).
   • Static: If you installed OBS Studio using the official installer (.exe, .msi, ...) pick "all users", which will present you with the User Account Control dialog. 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 order to continue, click Yes.
   • Portable: If you installed OBS Studio using an archive (.zip, .7z, ...), pick "me only". This will lock away the Static installation method later on.
4. Follow the remaining steps in the Installer.
5. Done.

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

⚠ Due to a bug in the MacOS Package Installer, extra caution needs to be paid to these steps. Failure to adhere to them will cause the plugin to not install correctly.

1. Download the .pkg Installer of the latest Production or Testing release of your choice for MacOS.
2. Option Click (or Right Click) on the .pkg file.
3. Select Open, which will bypass an annoying safety warning.
   • A window will pop up asking if you trust this file. To continue you have to select Open.
4. A Package Installer window will now appear, which you can follow until the Installation Type step.
5. On the Installation Type step, click the Change Install Location... button.
   • This may now ask you for permission to access your files, however this permission is not needed.
6. Select Install for me only and click Continue.
7. Click Install to install StreamFX.
8. Click Close to finish installing.
9. Done.

Community Maintained Releases

These releases are maintained by one or more members of the community, and are as such offered with no warranty, promise of functionality, or support. Only the official releases will be supported by StreamFX maintainers and volunteer support.

Linux (Flatpak)

1. Run flatpak install com.obsproject.Studio.Plugin.StreamFX in a Terminal.
2. Done.

Arch Linux

1. Install obs-streamfx package from AUR via a helper such as yay or pamac.
2. Done.

Building from Source

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.