Skip to content

v0.1.0

Latest
Latest

Choose a tag to compare

View all tags
@CodeBhaukaal CodeBhaukaal released this 11 Sep 10:00
· 1 commit to main since this release
v0.1.0
b825ecf

First release. Download the installer below, close OBS, and run it.

What it does

Finds sensitive text on your screen with local OCR and redacts it before the frame reaches your stream. API keys, .env values, passwords, tokens, email addresses, private URLs, or any keyword you type in.

Everything runs on your machine. No cloud OCR, no API key, and recognized text is never written to the log or to disk.

Install

  1. Close OBS Studio.
  2. Run the installer. It needs administrator rights because OBS reads plugins from C:\ProgramData.
  3. Start OBS, right-click a Display Capture or Window Capture source, choose Filters, and add Sensitive Guard under Effect Filters.
  4. Type your keywords, one per line.
  5. Bind the emergency hotkeys in Settings → Hotkeys.

The OCR models are bundled, so there is nothing else to download.

Read this before you rely on it

OCR scale decides what can be detected at all. Text smaller than the limit is invisible to detection and will never be hidden.

OCR scale Smallest readable text
55% 14 px
75% 10 px
100% 8 px

Expect pixelation on big screen changes. A frame is only released clean once OCR has finished inspecting it. When the screen changes faster than OCR can keep up, the source is covered rather than shown unredacted. Narrow the region of interest to shorten those windows.

OCR cannot guarantee 100% detection. Very small text, low contrast, unusual fonts and brief flashes can all be missed. Use permanent masks for fixed areas like a browser URL bar, bind the blackout hotkey, and add an OBS stream delay so you have time to react to what OCR was never going to catch.

Requirements

  • Windows x64
  • OBS Studio 30 or newer, tested on 32.2.2
  • A DirectX 12 GPU for GPU detection, which is optional. CPU works.

Measured on a Ryzen 7 3700X and an RTX 3060

Scanning a full 1920x1080 desktop with roughly 200 lines of text:

Stage CPU GPU (DirectML)
Detection, warm 605 ms 99 ms
Repeat scan, nothing changed 2 ms 2 ms

Detection runs on the selected device. Recognition always stays on the CPU, where it measured nearly three times faster than the same GPU.

Licenses

GPL-2.0, matching OBS Studio. Bundled components and their licenses are listed in THIRD-PARTY-NOTICES.md.

Assets 3
Loading