2 Commits

Author SHA1 Message Date
130bf74f27 add note about pyz included in Releases. 2025-06-25 16:56:38 +01:00
b8bcea59fc add link to OBS
add note about env vars
2025-06-25 15:17:45 +01:00

View File

@@ -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,26 @@ uv tool install simple-recorder
pipx install simple-recorder
```
*with pyz*
An executable pyz has been included in [Release](https://github.com/onyx-and-iris/simple-recorder/releases) which you can run in Windows. Follow the steps in this [Setting up Windows for Zipapps](https://jhermann.github.io/blog/python/deployment/2020/02/29/python_zippapps_on_windows.html#Setting-Up-Windows-10-for-Zipapps) guide.
## 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 +83,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/