diff --git a/example_plugins/README.md b/example_plugins/README.md new file mode 100644 index 0000000..885f733 --- /dev/null +++ b/example_plugins/README.md @@ -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.