Added custom plugin guidance

pull/1/head
Geoff Whittington 2023-04-27 21:21:43 -04:00
rodzic 51421fc217
commit a4b153f992
1 zmienionych plików z 17 dodań i 0 usunięć

Wyświetl plik

@ -0,0 +1,17 @@
# Custom plugins
Custom plugins allow users to create their own behaviors when a Meshtastic or Matrix message is detected. A sample plugin `hello_world.py` is provided.
NOTE: Custom plugins are not supported with the Windows installer option.
## Development
Custom plugins should be written as a subclass of `plugins.base_plugin.BasePlugin` and given a file extension `.py`. The class should be given a unique `plugin_name`.
## Installation
Custom plugins should be copied to `custom_plugins` directory. They are detected upon startup of the relay.
## Troubleshooting
Each plugin has access to a `self.logger` that can be useful in troubleshooting runtime issues.