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

update README

Browse Source
This commit is contained in:
onyx-and-iris 2025-06-26 06:16:40 +01:00
parent d28d5a578a
commit b6c0e9dece
1 changed files with 22 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -46,21 +46,26 @@ Or load them from your environment:
OBS_HOST=localhost OBS_HOST=localhost
OBS_PORT=4455 OBS_PORT=4455
OBS_PASSWORD=<websocket password> OBS_PASSWORD=<websocket password>
OBS_THEME=Reds
``` ```
## Use ## Use
Without passing a subcommand (start/stop) a GUI will be launched, otherwise a CLI will be launched.
### GUI ### GUI
To launch the GUI run the root command without any subcommands:
```console
simple-recorder
```
![simple-recorder](./img/simple-recorder.png) ![simple-recorder](./img/simple-recorder.png)
Just enter the filename and click *Start Recording*. Just enter the filename and click *Start Recording*.
#### Themes #### Themes
Load the GUI with different themes: Passing flags is fine, however, for example to set the theme:
```console ```console
simple-recorder --theme="Light Purple" simple-recorder --theme="Light Purple"
@ -73,25 +78,28 @@ Available themes: Light Purple, Neutral Blue, Reds, Sandy Beach, Kayak, Light Bl
```shell ```shell
Usage: simple-recorder [OPTIONS] COMMAND Usage: simple-recorder [OPTIONS] COMMAND
┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ start Start recording ┃ ┃ start Start recording ┃
┃ stop Stop recording ┃ ┃ stop Stop recording ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ --host <HOST> ┃ ┃ --host <HOST> OBS WebSocket host ┃
┃ --port <PORT> ┃ ┃ --port <PORT> OBS WebSocket port ┃
┃ --password <PASSWORD> ┃ ┃ --password <PASSWORD> OBS WebSocket password ┃
┃ --theme <THEME> ┃ ┃ --theme <THEME> OBS WebSocket theme ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
``` ```
For example:
```console ```console
simple-recorder start "File Name" simple-recorder start "File Name"
simple-recorder stop 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/ [obs-studio]: https://obsproject.com/