You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12
Original file line number
Diff line number
Diff line change
@@ -44,10 +44,10 @@ This video on YouTube will take you through the major parts of the code and expl
44
44
</a>
45
45
</div>
46
46
47
-
## Requirements
48
-
- OBS version 28+ ([download](https://obsproject.com/download))
49
-
50
-
We do not support older versions of OBS since the plugin is using newer APIs.
47
+
## OBS Version Support and Compatibility
48
+
- OBS version 29+ ([download](https://obsproject.com/download)) for the latest version of this plugin, e.g. 1.1.x and above.
49
+
- OBS version 28+ for this plugin's version between 0.5.x and 1.0.x.
50
+
- OBS version 27+ for this plugin's version 0.4.x and below.
51
51
52
52
## Introduction
53
53
@@ -91,28 +91,28 @@ Some more information about how I built it: https://www.morethantechnical.com/20
91
91
92
92
## Building
93
93
94
-
The plugin was built and tested on Mac OSX, Windows and Ubuntu Linux. Help is appreciated in building on other OSs and packages.
94
+
The plugin was built and tested on Mac OSX (Intel & Apple silicon), Windows and several Linux disros (e.g. Ubuntu/Debian-ish, Fedora, and more). Help is appreciated in building on other OSs and packages.
95
95
96
-
The building pipelines in CI take care of the heavy lifting. Use them in order to build the plugin locally. Note that due to the fact we're building and packaging OpenCV and ONNX Runtime the build times are quite long.
96
+
The building pipelines in CI take care of the heavy lifting. Use them in order to build the plugin locally. We attempt to use external OpenCV, libcurl and ONNX Runtime to reduce build times.
97
97
98
98
Start by cloning this repo to a directory of your choice.
99
99
100
100
### Mac OSX
101
101
102
-
Using the CI pipeline scripts, locally you would just call the zsh script.
102
+
Using the CI pipeline scripts, locally you would just call the zsh script. By default this builds a universal binary for both Intel and Apple Silicon. To build for a specific architecture please see `.github/scripts/.build.zsh` for the `-arch` options.
The above script should succeed and the plugin files will reside in the `./release` folder off of the root. Copy the files to the OBS directory e.g. `/Applications/OBS.app/Contents/`.
109
+
The above script should succeed and the plugin files (e.g. `obs-backgroundremoval.plugin`) will reside in the `./release/Release` folder off of the root. Copy the `.plugin` file to the OBS directory e.g. `~/Library/Application Support/obs-studio/plugins`.
(Note that maybe the outputs in the e.g. `build_x86_64`will be in the `Release` folder and not the `install` folder like `pakage-macos.zsh` expects, so you will need to rename the folder from `build_x86_64/Release` to `build_x86_64/install`)
115
+
(Note that maybe the outputs will be in the `Release` folder and not the `install` folder like `pakage-macos` expects, so you will need to rename the folder from `build_x86_64/Release` to `build_x86_64/install`)
0 commit comments