Keyboard input

Monitor OBS hotkeys.

Keyboard keys pressed trigger OBS hotkeys. The hotkey value is passed to a Text source.

The User creates a text sources to store and display incoming hotkey values.

A text source is used because changes to a text source are easily observed by WebSocket clients. When a text source is updated an "InputSettingsChanged" event is sent to webSocket clients. See the Key Overlay Example tutorial for a complete example.

Keyboard input.excalidraw.png

Setup

Add the Keyboard Input Script to OBS

The "Keyboard Input" script and accompanying OBS Collection can be found on Github.
python keyboard input repo

Import the Keyboard Input OBS Collection

  1. Download the Keyboard input Collection
  2. In OBS, from the menu select Scene Collection > Import
  3. Import the collection
  4. Choose the collection Scene Collection

Add the Script

  1. Download the Keyboard Input Script
  2. In OBS, from the menu select Tools > Scripts
  3. Click the + Add script button

Configure Text Source

Choose Source

Pasted image 20251116221619.png