mirror of
https://github.com/onyx-and-iris/simple-recorder.git
synced 2025-06-27 09:50:23 +01:00
add link to OBS
add note about env vars
This commit is contained in:
parent
ff1cf12d6e
commit
b8bcea59fc
19
README.md
19
README.md
@ -12,6 +12,7 @@ Run it as a CLI or a GUI.
|
||||
## Requirements
|
||||
|
||||
- Python 3.11 or greater
|
||||
- [OBS Studio 28+][obs-studio]
|
||||
|
||||
## Installation
|
||||
|
||||
@ -27,6 +28,22 @@ uv tool 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
|
||||
|
||||
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.
|
||||
|
||||
[obs-studio]: https://obsproject.com/
|
Loading…
x
Reference in New Issue
Block a user