mirror of
https://github.com/onyx-and-iris/obsws-python.git
synced 2026-04-18 22:13:32 +00:00
add readmes to examples.
This commit is contained in:
20
examples/hotkeys/README.md
Normal file
20
examples/hotkeys/README.md
Normal file
@@ -0,0 +1,20 @@
|
||||
## About
|
||||
|
||||
Sets up some hotkeys to trigger certain actions. Registers a callback function to notify of scene switch event.
|
||||
|
||||
Requires [Python Keyboard library](https://github.com/boppreh/keyboard).
|
||||
|
||||
## Use
|
||||
|
||||
Simply run the code and press the assigned hotkeys. Press `ctrl+enter` to exit.
|
||||
|
||||
This example assumes the existence of a `config.toml`, placed next to `__main__.py`:
|
||||
|
||||
```toml
|
||||
[connection]
|
||||
host = "localhost"
|
||||
port = 4455
|
||||
password = "mystrongpass"
|
||||
```
|
||||
|
||||
It also assumes the existence of scenes named `START`, `BRB` and `END`.
|
||||
Reference in New Issue
Block a user