add readmes to examples.

This commit is contained in:
onyx-and-iris
2022-08-31 20:13:44 +01:00
parent 7c6ebd1dae
commit 66a06617c6
4 changed files with 53 additions and 3 deletions

View 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`.