simple-recorder

A simple OBS recorder app. Run it as a CLI or a GUI.

Requirements

Python 3.11 or greater
OBS Studio 28+

Installation

with uv

uv tool install simple-recorder

with pipx

pipx install simple-recorder

with pyz

Download the pyz file in Releases
Optional step: for automatic discovery of the pyz file follow this guide on Setting Up Windows for Zippapps

Finally run the pyz with python (CLI)/pythonw (GUI):

python simple-recorder.pyz <subcommand>

pythonw simple-recorder.pyz

note, the pyz extension won't be required if you followed the optional step and made it discoverable.

Configuration

Pass --host, --port and --password as flags on the root command:

simple-recorder --host=localhost --port=4455 --password=<websocket password> --help

Or load them from your environment:

OBS_HOST=localhost
OBS_PORT=4455
OBS_PASSWORD=<websocket password>
OBS_THEME=Reds

Use

CLI

To launch the CLI:

simple-recorder start "File Name"

simple-recorder stop

Commands:

Usage: simple-recorder [OPTIONS] COMMAND

┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ start      Start recording                                                          ┃
┃ stop       Stop recording                                                           ┃
┃ pause      Pause recording                                                          ┃
┃ resume     Resume recording                                                         ┃
┃ split      Split the current recording into a new file                              ┃
┃ chapter    Create a chapter in the current recording                                ┃
┃ directory  Get or set the recording directory                                       ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ --host <HOST>          OBS WebSocket host                                           ┃
┃ --port <PORT>          OBS WebSocket port                                           ┃
┃ --password <PASSWORD>  OBS WebSocket password                                       ┃
┃ --theme <THEME>        GUI theme (Light Purple, Neutral Blue, Reds, Sandy Beach,    ┃
┃                        Kayak, Light Blue 2)                                         ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

GUI

To launch the GUI:

simple-recorder-gui

Just enter the filename and click Start.

Themes

You can change the colour theme with the --theme option:

simple-recorder-gui --theme="Light Purple"

4.0 KiB Raw Blame History