onyx_online/simple-recorder
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/simple-recorder.git synced 2025-06-27 09:50:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

add link to OBS

Browse Source 
add note about env vars
This commit is contained in:
onyx-and-iris 2025-06-25 15:17:45 +01:00
parent ff1cf12d6e
commit b8bcea59fc
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -12,6 +12,7 @@ Run it as a CLI or a GUI.
## Requirements ## Requirements
- Python 3.11 or greater - Python 3.11 or greater
- [OBS Studio 28+][obs-studio]
## Installation ## Installation
@ -27,6 +28,22 @@ uv tool install simple-recorder
pipx install simple-recorder pipx install simple-recorder
``` ```
## Configuration
Pass --host, --port and --password as flags on the root command:
```console
simple-recorder --host=localhost --port=4455 --password=<websocket password> --help
```
Or load them from your environment:
```env
OBS_HOST=localhost
OBS_PORT=4455
OBS_PASSWORD=<websocket password>
```
## Use ## Use
Without passing a subcommand (start/stop) a GUI will be launched, otherwise a CLI will be launched. Without passing a subcommand (start/stop) a GUI will be launched, otherwise a CLI will be launched.
@ -62,3 +79,5 @@ simple-recorder stop
``` ```
If no filename is passed to start then you will be prompted for one. A default_name will be used if none is supplied to the prompt. If no filename is passed to start then you will be prompted for one. A default_name will be used if none is supplied to the prompt.
[obs-studio]: https://obsproject.com/