Skip to content

About StreamFX

Xaymar edited this page Oct 7, 2024 · 25 revisions

About StreamFX

What is StreamFX?

StreamFX - or 'Stream Effects' in earlier days - is a collection of Sources, Filters, Transitions, Encoders and other Features. From simple effects like Blur, all the way to advanced effects like Shaders, StreamFX aims to provide features that can be used to achieve higher complexity and more fancy scene layouts in OBS Studio. It does so by extending from OBS Studio, and replaces no original OBS Studio functionality.

Why does StreamFX exist? Who was it made for?

This project was initially developed to meet the needs of my friends, family, and myself. Nearly every feature in the plugin arose from the desire to break free from the limitations of standard OBS Studio behavior. Over time, it was made available to the public, particularly for advanced users, which helped uncover and fix many hidden bugs.

Frequently Asked Questions

Is StreamFX free?

No. We offer both source code and binary releases exclusively to our Patreon supporters at the Silver tier or higher.

Do I need an active subscription to use StreamFX?

No, you can cancel at any time, and any binaries or source code you’ve downloaded prior to cancellation are yours to keep forever. There are no restrictions requiring an active subscription to use the software—once you’ve downloaded it, it’s yours to keep.

How can I download StreamFX?

If you have an active Patreon subscription at the Silver tier or higher, simply link your Patreon and Discord accounts. This will grant you access to our Discord, where the latest releases are available for download. This system is temporary while we work on developing our new website.

Why is StreamFX no longer free?

Will StreamFX be free again eventually?

Due to an unexpected surge in users and limited funding, we have transitioned the plugin from a free to a paid model. We explored all possible ways to maintain a free version through increased funding, but unfortunately, none were successful. Our attempts to boost donations were even met with hostility, piracy, theft, threats, and even physical assault. As a result, we are no longer interested in pursuing the original free model.

What subscription model does StreamFX operate under?

Our subscription model operates like a perpetual SLA licensing system. You can subscribe for a month to receive updates and support during that period, and cancel at any time. When you want to update again, simply resubscribe. There are no restrictions requiring an active subscription to continue using the software—once you've downloaded it, it’s yours to keep.

What features are planned for the future? What will be fixed when?

Unfortunately crystal balls and fortunetelling do not work as imagined, so we quite literally don't know - it'll be done when it's done. We've attempted to publish a roadmap here on GitHub, however this is currently unreadable due to Github limitations. Just check the discord channel #commits for changes.

What libOBS software is supported by StreamFX?

What OBS software is supported by StreamFX?
Software Supported? Reason
OBS Studio The original OBS Studio is supported as long as you meet the System Requirements.
StreamElements.live Partially supported, as it is a simple fork of OBS Studio. Ensure that your version meets the System Requirements and that you picked the correct installation location.
Streamlabs OBS Not an OBS Studio fork, it merely uses libOBS for its functionality. As neither Qt nor a proper obs-frontend-api is present, StreamFX does not support it.
XSplit Why did you even ask?

Why is 32-bit no longer supported?

Just like 16-bit back when 32-bit took over, 32-bit has been vastly outclassed by 64-bit in functionality, speed, extensions, support, and practically every aspect you can think of for more than 10 years. It has inherent limits which simply are no longer sane to support, and just cause everything to run more than 3 times slower than any 64-bit code would. StreamFX therefore no longer officially supports 32-bit, as many of the issue reports simply boiled down to people not understanding the limits of 32-bit.

The project is not alone in this decision, with many other software and hardware creators also opting to drop 32-bit in favor of 64-bit. While some have opted for a slow transition phase, others have dropped it instantly like StreamFX has done. If you are still using 32-bit-only hardware/software, you should consider upgrading or paying someone for a 32-bit libOBS plugin bridge.

What release type / update channel should I use?

Type Description
🔴Alpha Alphas are as unstable as things can get, and should be avoided at all cost in Production or Live enviroments. They contain the latest changes of any kind, and may include an unusual amount of problems. Bugs, Crashes, Freezes, Corruptions, etc should all be fully expected when using these.

These releases will have a version number containing the letter `a`.

All promises of support, warranty or functionality are void.
🟠Beta Betas are more stable than Alphas, but may contain the same amount of bugs and crashes. They should be avoided in Production or Live enviroments.

These releases will have a version number containing the letter `b`.

All promises of support, warranty or functionality are void.
🟡Candidate Release Candidates are potential Stable releases which still need some testing, but may be used in Production or Live environments. Some bugs and crashes should be expected.

These releases will have a version number containing the letter `c`.

All promises of warranty or functionality are void.
🟢Stable Stable builds have passed all important tests and should be ready for Production or Live environments.

How can I tell which platforms a feature supports?

The feature will have the following symbols somewhere on the page, usually in the title:

  • Windows denotes availability on Windows.
  • Linux denotes availability on Linux.
  • MacOS denotes availability on MacOS.

What does 🔴, 🟠 and 🟢 mean on a Feature?

Type Description
🔴Experimental Experimental features are experiments that may or may not end up as permanent functionality of StreamFX. These should be avoided for Production or Live environments, as they may behave unexpectedly and cause unforeseen consequences. These features may also be removed at any point, or have their entire functionality changed without notice.

All promises of support, warranty or functionality are void.
🟠Unstable Features marked Unstable have passed the Experimental stage and will stay in StreamFX. These may be used in Production or Live environments with caution, as their functionality may change in the future. They may also still behave unexpectedly and cause unforeseen consequences.

All promises of warranty or functionality are void.
🟢Stable Stable features are ready for Production or Live environments. These have been well tested and usually behave exactly as advertised, and usually do not change drastically.
⚠Deprecated This feature has a better replacement available and is scheduled to be removed soon.

All promises of support, warranty or functionality are void.
❌Removed This feature was removed for various reasons.

All promises of support, warranty or functionality are void.

How can I tell that StreamFX has been successfully installed?

You can either check the log file, or check if any of the features it adds are present.

Clone this wiki locally