occ-ai / obs-backgroundremoval

An OBS plugin for removing background in portrait images (video), making it easy to replace the background when recording or streaming.
GNU General Public License v2.0
2.7k stars 185 forks source link

Please tell me the right instructions to install the plugin on WIndows #489

Closed crowlsyong closed 7 months ago

crowlsyong commented 8 months ago

Describe the bug

Running $ flatpak install com.obsproject.Studio.Plugin.BackgroundRemoval on Windows results in an error. Additional configuration is required to make it work on Windows, and the provided guide does not explain how to do that, making the instructions unclear.

To Reproduce

Steps to reproduce the behavior:

Open a Windows command prompt or PowerShell. Run the command: $ flatpak install com.obsproject.Studio.Plugin.BackgroundRemoval Observe the error indicating that Flatpak is not recognized as a valid command. Expected behavior

I expected the command to install the OBS Studio Plugin Background Removal on Windows as described in the provided guide.

Screenshots

N/A

Log and Crash Report

N/A

Desktop

OS: Windows 10 (or your specific Windows version) Browser: N/A Plugin Version: N/A (Please specify if known) OBS Version: N/A (Please specify if known) Additional context

The issue occurs because Flatpak is a package management system primarily designed for Linux, and attempting to use it on Windows results in the "Flatpak is not recognized" error. The guide does not provide instructions for Windows users, leading to confusion. It would be helpful to include Windows-specific installation instructions or clarify that Flatpak is not intended for use on Windows.

crowlsyong commented 8 months ago

PowerShell 7.3.9 PS C:\Windows\System32> flatpak install com.obsproject.Studio.Plugin.BackgroundRemoval flatpak: The term 'flatpak' is not recognized as a name of a cmdlet, function, script file, or executable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. PS C:\Windows\System32> github/scripts/Build-Windows.ps1 -Target x64 -CMakeGenerator "Visual Studio 17 2022" github/scripts/Build-Windows.ps1: The term 'github/scripts/Build-Windows.ps1' is not recognized as a name of a cmdlet, function, script file, or executable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. PS C:\Windows\System32> PS C:\Windows\System32> .github/scripts/Build-Windows.ps1 -Target x64 -CMakeGenerator "Visual Studio 17 2022" .github/scripts/Build-Windows.ps1: The term '.github/scripts/Build-Windows.ps1' is not recognized as a name of a cmdlet, function, script file, or executable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. PS C:\Windows\System32> .github/scripts/Build-Windows.ps1 -Target x64 -CMakeGenerator "Visual Studio 17 2022" .github/scripts/Build-Windows.ps1: The term '.github/scripts/Build-Windows.ps1' is not recognized as a name of a cmdlet, function, script file, or executable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. PS C:\Windows\System32>

None of the windows instructions work.

royshil commented 8 months ago

On Windows you can download https://github.com/occ-ai/obs-backgroundremoval/releases/download/1.1.7/obs-backgroundremoval-1.1.7-windows-x64-Installer.exe and double click it to install

RheeUK commented 8 months ago

I run this on an environment where we get this when using exe. The zip files do not work.

image

umireon commented 8 months ago

This error is caused by the recent change in our URL. We cannot do anything to remove this error screen but you have to do some actions. Please refer this article to allow our installer to be run. https://www.addictivetips.com/windows-tips/fix-no-run-anyway-option-on-smartscreen-windows-10/#:~:text=to%20show%20up.-,No%20Run%20Anyway%20option%20on%20SmartScreen,-The%20options%20that

umireon commented 8 months ago

Signing our installer won't fix this error screen. When so many people download our installer from the new URL, this error screen will be gone. Thus, it will take some time to resolve this issue of the error screen.

RheeUK commented 8 months ago

Signing our installer won't fix this error screen. When so many people download our installer from the new URL, this error screen will be gone. Thus, it will take some time to resolve this issue of the error screen.

I cannot bypass organisation policies to install it I'm afraid. How do I install manually please?

umireon commented 8 months ago

@RheeUK Can you file a new issue for assistance?

Smurfettesims commented 7 months ago

On Windows you can download https://github.com/occ-ai/obs-backgroundremoval/releases/download/1.1.7/obs-backgroundremoval-1.1.7-windows-x64-Installer.exe and double click it to install

is this the version that actually works for Windows 10? I manually installed the files and they do not show up in OBS. Just want to be able to use the plugin or if it doesn't work can you point to one that will work the same/similar? Thanks

umireon commented 7 months ago

@Smurfettesims Please do not post an off-topic comment on stalled issues.