mirror of
https://github.com/onyx-and-iris/simple-recorder.git
synced 2026-04-20 16:23:34 +00:00
Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0fe22debb6 | |||
| d8d7fce5cc | |||
| ca7604c279 |
64
README.md
64
README.md
@@ -49,6 +49,38 @@ OBS_THEME=Reds
|
||||
|
||||
## Use
|
||||
|
||||
### CLI
|
||||
|
||||
To launch the CLI pass any subcommand, for example:
|
||||
|
||||
```console
|
||||
simple-recorder start "File Name"
|
||||
|
||||
simple-recorder stop
|
||||
```
|
||||
|
||||
#### Commands:
|
||||
|
||||
```shell
|
||||
Usage: simple-recorder [OPTIONS] COMMAND
|
||||
|
||||
┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃ start Start recording ┃
|
||||
┃ stop Stop recording ┃
|
||||
┃ pause Pause recording ┃
|
||||
┃ resume Resume 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 run the root command without any subcommands:
|
||||
@@ -69,36 +101,4 @@ You can change the colour theme with the --theme option:
|
||||
simple-recorder --theme="Light Purple"
|
||||
```
|
||||
|
||||
### CLI
|
||||
|
||||
```shell
|
||||
Usage: simple-recorder [OPTIONS] COMMAND
|
||||
|
||||
┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃ start Start recording ┃
|
||||
┃ stop Stop recording ┃
|
||||
┃ pause Pause recording ┃
|
||||
┃ resume Resume recording ┃
|
||||
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||
|
||||
┏━ 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) ┃
|
||||
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||
```
|
||||
|
||||
To launch the CLI pass any subcommand (start/stop etc...), for example:
|
||||
|
||||
```console
|
||||
simple-recorder start "File Name"
|
||||
|
||||
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/
|
||||
@@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "simple-recorder"
|
||||
version = "0.3.0"
|
||||
version = "0.3.1"
|
||||
description = "A simple OBS recorder"
|
||||
authors = [{ name = "onyx-and-iris", email = "code@onyxandiris.online" }]
|
||||
dependencies = [
|
||||
|
||||
@@ -32,5 +32,5 @@ class Directory(Command):
|
||||
f"Current recording directory: {highlight(resp.record_directory)}"
|
||||
)
|
||||
return resp.record_directory
|
||||
except Exception as e:
|
||||
raise SimpleRecorderError(f"Failed to get recording directory: {e}")
|
||||
except TimeoutError:
|
||||
raise SimpleRecorderError("Failed to connect to OBS. Is it running?")
|
||||
|
||||
Reference in New Issue
Block a user