README and LICENSE

LICENSE

@@ -0,0 +1,16 @@
+OBSBlur allows users to have an overlay on top of Display Captures to hide sensitive data.
+
+COPYRIGHT (C) 2024 Glax
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.

README.md

@@ -0,0 +1,21 @@
+# OBSBlur
+...allows the _safer_ use of DisplayCaptures in OBS Studio, by overlaying an image
+over specific windows. There is **_no guarantee_** that there will be absolutely no
+information spill. No responsibility is taken by me.
+
+## Prerequisites
+OBS-Websocket (now included in OBSStudio by default).
+
+## Installation and configuration
+Download, or compile, OBSBlur and start.
+A `config.json` will be created in the same folder.
+
+Edit values to match OBS-Websocket settings (include `ws://` before the address).
+
+There is two options for blurring:
+1. By executable (e.g. chrome.exe) `BlurPrograms`
+2. By window-title `BlurWindows`
+
+`EnabledScenes` is a collection of Scene-Names (OBS) where there is a DisplayCapture.
+
+`DisplayCaptureName` is the name of the SceneItem (Source) that should be referenced for position.