@@ -10,7 +10,7 @@ Stabilise high-throughput USB capture devices for OBS on Linux. Provides auto-re
1010- ** Auto-reconnect** — Monitors device and restarts feed on disconnect
1111- ** USB reset & driver rebind** — Recovers from device hangs without reboot
1212- ** Performance optimisations** — Disables USB autosuspend, optimises power settings
13- - ** HDR passthrough** — Configurable color handling modes
13+ - ** HDR passthrough** — Configurable colour handling modes
1414- ** Optional overlay** — Add logo/watermark from URL or file
1515- ** Format auto-detection** — Detects best resolution/fps during install
1616- ** Wayland graphics optimisation** — Fixes OBS crashes on Wayland with explicit sync and PipeWire support
@@ -66,14 +66,14 @@ A comprehensive interactive maintenance system is available for troubleshooting
6666sudo ./scripts/maintenance.sh
6767```
6868
69- This menu provides access to 9 specialized recovery tools:
69+ This menu provides access to 9 specialised recovery tools:
7070
7171| Tool | Description | Use When |
7272| ------| -------------| ----------|
7373| ** detect_device** | Enumerate USB video devices | Device not found or caps unclear |
7474| ** disable_overlay** | Remove on-screen logos/OSD | Capture has unwanted watermarks |
7575| ** hard_reset** | Unbind/rebind USB driver | Device unresponsive but enumerated |
76- | ** optimise_device** | Disable autosuspend, optimize power | Timeouts, USB power errors |
76+ | ** optimise_device** | Disable autosuspend, optimise power | Timeouts, USB power errors |
7777| ** pick_delogo** | Visually select logo region | Need to identify overlay position |
7878| ** repair** | Full recovery workflow | Device broken, try complete reset |
7979| ** simulate_disconnect** | Test device authority toggle | Testing/diagnostics only |
@@ -124,7 +124,7 @@ For detailed buffer corruption diagnosis, see **[BUFFER_CORRUPTION.md](BUFFER_CO
124124| --------| ---------|
125125| [ ` install.sh ` ] ( ../scripts/install.sh ) | Interactive setup: detect device, install services, v4l2loopback |
126126| [ ` validate_capture.sh ` ] ( ../scripts/validate_capture.sh ) | Test device for corruption, timeouts, USB power issues |
127- | [ ` optimise_device.sh ` ] ( ../scripts/optimise_device.sh ) | Disable autosuspend, optimize USB power for device |
127+ | [ ` optimise_device.sh ` ] ( ../scripts/optimise_device.sh ) | Disable autosuspend, optimise USB power for device |
128128| [ ` optimise_drivers.sh ` ] ( ../scripts/optimise_drivers.sh ) | Fix OBS Wayland crashes (Nvidia/AMD/Intel) |
129129| [ ` auto_reconnect.sh ` ] ( ../scripts/auto_reconnect.sh ) | Monitor device, auto-restart on disconnect |
130130| [ ` parse_formats.sh ` ] ( ../scripts/parse_formats.sh ) | Auto-detect best resolution/fps from device |
@@ -156,21 +156,21 @@ All settings in `/etc/default/usb-capture`:
156156
157157### HDR Modes
158158
159- | Mode | Behavior |
159+ | Mode | Behaviour |
160160| ------| ----------|
161161| ` 0 ` | Auto — trust device (may delay startup) |
162162| ` 1 ` | Force HDR interpretation + tonemap to SDR |
163163| ` 2 ` | Force HDR passthrough (fastest startup) ** ← default** |
164164| ` 3 ` | Force SDR interpretation |
165165
166- Most devices auto-handle HDR internally. Mode 2 provides fastest startup without color issues.
166+ Most devices auto-handle HDR internally. Mode 2 provides fastest startup without colour issues.
167167
168168## OBS Setup
169169
170170### Standard Setup
171171
1721721 . Add ** Video Capture Device** source
173- 2 . Select ` /dev/video10 ` (labeled "USB_Capture_Loop")
173+ 2 . Select ` /dev/video10 ` (labelled "USB_Capture_Loop")
1741743 . Resolution/FPS auto-detected
175175
176176If device not visible:
@@ -325,7 +325,7 @@ nvidia-smi # Check current version
325325sudo ./scripts/optimise_drivers.sh --amd
326326```
327327
328- Ensures AMDGPU driver is optimised for Wayland, enables color block compression.
328+ Ensures AMDGPU driver is optimised for Wayland, enables colour block compression.
329329
330330### Intel GPU
331331
@@ -428,7 +428,7 @@ lsusb
428428sudo nano /etc/udev/rules.d/99-usb-capture-optimisation.rules
429429```
430430
431- Add the rule (customize VID: PID for your device):
431+ Add the rule (customise VID: PID for your device):
432432``` udev
433433ACTION=="add", SUBSYSTEM=="usb", ATTR{idVendor}=="3188", ATTR{idProduct}=="1000", ATTR{power/control}="on", ATTR{power/autosuspend_delay_ms}="-1"
434434```
0 commit comments