Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
!buildspec.json
!CMakeLists.txt
!CMakePresets.json
!FAQ.md
!LICENSE
!README.md
!vcpkg-configuration.json
Expand Down
253 changes: 253 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,253 @@
# OBS Background Removal – Frequently Asked Questions

Below are 50 real-world question & answer pairs based on common issues and discussion topics for the [royshil/obs-backgroundremoval](https://github.com/royshil/obs-backgroundremoval) OBS plugin.

---

### 1. **Q: How do I install the OBS Background Removal plugin?**
**A:** Download the release matching your operating system from the [official website](https://royshil.github.io/obs-backgroundremoval), which redirects to the proper files and detailed instructions. Follow the steps for your OS to extract and place files in OBS's plugins folder, then restart OBS.

---

### 2. **Q: Which versions of OBS Studio are supported?**
**A:** The plugin supports OBS Studio version 31.1.1 or later. Compatibility with earlier versions is not guaranteed.

---

### 3. **Q: Does the plugin work on Windows, macOS, and Linux?**
**A:** Yes, builds are provided for Windows, macOS (Intel and ARM), and Linux. Platform-specific instructions are available on the [official website](https://royshil.github.io/obs-backgroundremoval).

---

### 4. **Q: I see 'Failed to load Background Removal plugin' in OBS. What’s wrong?**
**A:** This usually indicates missing dependencies or an incorrect installation path. Make sure you followed the installation steps, placed files correctly, and installed any required runtimes for your OS.

---

### 5. **Q: What are the minimum hardware requirements for using this plugin?**
**A:** A CPU with AVX instructions is required. For best performance, use a modern, multi-core CPU. GPU acceleration is currently not supported.

---

### 6. **Q: Can I use my GPU for background removal?**
**A:** No, GPU support is currently dropped from the plugin. There are plans to bring back GPU acceleration in the future, but for now all processing is CPU-based.

---

### 7. **Q: What AI model is used for background removal?**
**A:** The plugin uses machine learning models such as MODNet and Selfie Segmentation (MediaPipe). You can select the model in the filter settings.

---

### 8. **Q: How can I update the plugin to a newer version?**
**A:** Download the latest release from [the official web page](https://royshil.github.io/obs-backgroundremoval) and overwrite your existing plugin files. Always back up your settings before updating.

---

### 9. **Q: Does the plugin support real-time video background removal?**
**A:** Yes, the plugin is designed for real-time use in live video streams.

---

### 10. **Q: Is chroma keying still needed with this plugin?**
**A:** No. The plugin detects and removes the background without needing any green screen or chroma key setup.

---

### 11. **Q: What causes a black or transparent background instead of the removed background?**
**A:** This often happens if the filter is misconfigured or the background image/video source is not correctly added. Check filter order and that 'Background Removal' is enabled on the right source.

---

### 12. **Q: Can I use a custom background instead of simply removing it?**
**A:** Yes. Add your desired background (image, video, etc.) as a lower-layer or separate source in your OBS scene below the camera feed.

---

### 13. **Q: Background removal is lagging or stuttering. How can I improve performance?**
**A:** Lower the resolution of your camera source and use a faster (less accurate) model. Since GPU acceleration is not available, performance depends on CPU speed.

---

### 14. **Q: Are there configuration options to refine removal quality?**
**A:** Yes—parameters such as model, threshold, and smoothing can be changed in the filter properties to optimize results.

---

### 15. **Q: How can I add the background removal filter to my camera?**
**A:** Right-click your video source in OBS, select "Filters", add an "Effect Filter", then choose "Background Removal".

---

### 16. **Q: Does the plugin remove backgrounds from images or only video?**
**A:** It is designed primarily for real-time video sources (camera input) but will work on any OBS video source.

---

### 17. **Q: Can this plugin be used on multi-camera setups in OBS?**
**A:** Yes. You can add the background removal filter to multiple video sources (such as different cameras) in your OBS scene. Each source can have its own filter settings, but be aware that CPU usage increases with every additional active filter.

---

### 18. **Q: Is Multi-Person segmentation supported?**
**A:** Currently, the plugin focuses on single-person foreground segmentation. Multi-person scenarios may produce sub-optimal results.

---

### 19. **Q: The plugin crashes OBS on startup. What should I do?**
**A:** First, ensure you have the latest plugin and OBS versions. Second, remove any conflicting plugins and check your hardware meets requirements. If issues persist, open a GitHub issue with your log file.

---

### 20. **Q: Where can I report bugs or request new features?**
**A:** Use the [GitHub Issues page](https://github.com/royshil/obs-backgroundremoval/issues) to report bugs or request features. Attach logs or screenshots as needed.

---

### 21. **Q: Does this plugin track or transmit video data?**
**A:** No. All processing is done locally on your system; no data is uploaded.

---

### 22. **Q: Are there any privacy risks when using the plugin?**
**A:** This plugin has the ability to connect to the internet, but this is only used for checking the latest version information. No video or user data is sent externally.

---

### 23. **Q: Are there any known incompatibilities with other OBS plugins?**
**A:** Most major plugins are compatible, but issues may arise with older or deprecated plugins. Test configurations and check the documentation.

---

### 24. **Q: How do I build the plugin from source?**
**A:** Build instructions will be available on the [official website](https://royshil.github.io/obs-backgroundremoval), but the documentation is still being prepared.

---

### 25. **Q: What platforms are supported for building from source?**
**A:** You can build on Windows (Visual Studio), macOS (Xcode/CMake), and Linux (CMake/GCC or Clang).

---

### 26. **Q: Can I use the plugin with virtual cameras?**
**A:** Yes, as long as the virtual camera appears as a standard video source in OBS.

---

### 27. **Q: The download is blocked by antivirus software. What do I do?**
**A:** This is usually a false positive, as the plugin is not harmful. Download from [the official site](https://royshil.github.io/obs-backgroundremoval), and add an exception if necessary.

---

### 28. **Q: Can I use the plugin in OBS Portable Mode?**
**A:** Yes. To use the plugin with OBS Portable Mode, extract the plugin files into the appropriate "portable_config" plugin folders within your OBS Portable directory. Installation steps are similar to standard installation, except the plugins directory is inside your portable OBS path.

---

### 29. **Q: Can the plugin be used with pre-recorded video files or only live cameras?**
**A:** Yes. Apply the filter to any OBS video source, including video files.

---

### 30. **Q: Is there an API or scripting interface for background removal?**
**A:** Not currently. The plugin is used by applying filters via the OBS UI.

---

### 31. **Q: Does this plugin support advanced chroma separation for green screens?**
**A:** No, this plugin is for green screen–less background removal using AI segmentation.

---

### 32. **Q: Where can I download sample backgrounds to use?**
**A:** You can use any image or video file as a background by adding it as a source in your OBS scene.

---

### 33. **Q: Is there support for removing backgrounds from low-light or noisy images?**
**A:** Difficult lighting or image noise can reduce segmentation quality. Good even lighting works best.

---

### 34. **Q: How do I change the AI model used for segmentation?**
**A:** Go to the filter settings and select the desired model from the dropdown menu. Try MODNet or SelfieSeg.

---

### 35. **Q: How do I revert to the original camera feed (disable background removal)?**
**A:** Toggle the background removal filter off or remove it from your source in OBS.

---

### 36. **Q: Where can I find logs to attach to a bug report?**
**A:** OBS logs are located in the Help > Log Files menu. Attach the most recent log when filing an issue.

---

### 37. **Q: I'm getting “Cannot find model file” errors.**
**A:** This means the required model files were not found. Re-install the plugin and make sure all files (including model folders) were extracted correctly.

---

### 38. **Q: Can I adjust the edge smoothing of the subject in the segmentation mask?**
**A:** Yes. The plugin provides smoothing and feathering parameters to help refine the edge of the mask around the subject. You can find and adjust these parameters in the filter's settings to better match your production environment.

---

### 39. **Q: Are there plans to support AMD, NVIDIA, or Intel GPUs in the future?**
**A:** GPU acceleration is currently unavailable for all platforms. There are plans to bring back GPU support, including for AMD, NVIDIA, and possibly Intel GPUs, in future releases.

---

### 40. **Q: Can I use the plugin together with OBS virtual background plugins?**
**A:** It's best to use only one background removal method at a time to avoid conflicts.

---

### 41. **Q: My OBS is not loading the plugin after restarting.**
**A:** Check if the plugin files were placed in the correct versioned plugins directory, and verify file permissions if on Linux or macOS.

---

### 42. **Q: How do I uninstall the OBS Background Removal plugin?**
**A:** Uninstall instructions are available on the [official website](https://royshil.github.io/obs-backgroundremoval). Generally, you can remove the plugin files from your OBS plugins directory and restart OBS.

---

### 43. **Q: The plugin causes high CPU usage. How can I reduce it?**
**A:** Lower the camera resolution, switch to a lighter model. Since GPU acceleration is not available, performance improvements depend on CPU settings.

---

### 44. **Q: Does the plugin support automatic background blurring?**
**A:** Yes, the plugin provides an AI-based background blurring feature. Enable the "Blur Background" property in the filter settings to blur the background behind the subject.

---

### 45. **Q: Will using this plugin affect my stream performance?**
**A:** Using ML models is computationally intensive. All processing is performed on the CPU, which may impact performance on lower-end machines.

---

### 46. **Q: Can I compile a custom model for use with the plugin?**
**A:** Only models matching the supported input/output and format can be used. Advanced users may experiment, but support is not provided.

---

### 47. **Q: Why is there a delay before the background is removed after switching scenes?**
**A:** The model may require a few frames to initialize when switching scenes or activating the filter.

---

### 48. **Q: My webcam freezes occasionally with the filter applied.**
**A:** Lower the input resolution or update your camera drivers. Test with different USB ports and cables as well.

---

### 49. **Q: Is there a way to support the project?**
**A:** Yes—star the repo, provide feedback, or contribute code. See the [Contributing guidelines](https://github.com/royshil/obs-backgroundremoval/blob/main/CONTRIBUTING.md).

---

### 50. **Q: Where can I find more information or get help?**
**A:** Check the [README](https://github.com/royshil/obs-backgroundremoval#readme), the [GitHub Discussions](https://github.com/royshil/obs-backgroundremoval/discussions), the issues page, or open a new issue for assistance.
Loading