mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-04-06 07:25:39 +00:00
513d1ec65b
- Introduced `[Earthquake_Service]` section in `config.ini.example` to enable earthquake alerts with customizable parameters such as polling interval, time window, and minimum magnitude. - Updated `service-plugins.md` to include documentation for the new Earthquake Service, detailing its functionality and default settings.
20 lines
1.1 KiB
Markdown
20 lines
1.1 KiB
Markdown
# Service Plugins
|
|
|
|
Service plugins extend the bot with background services that run alongside the main message loop. Each can be enabled or disabled in `config.ini`.
|
|
|
|
| Plugin | Description |
|
|
|--------|-------------|
|
|
| [Discord Bridge](discord-bridge.md) | One-way webhook bridge to post mesh messages to Discord channels |
|
|
| [Packet Capture](packet-capture.md) | Capture packets from the mesh and publish them to MQTT brokers |
|
|
| [Map Uploader](map-uploader.md) | Upload node advertisements to [map.meshcore.dev](https://map.meshcore.dev) for network visualization |
|
|
| [Weather Service](weather-service.md) | Scheduled weather forecasts, weather alerts, and lightning detection |
|
|
| [Earthquake Service](earthquake-service.md) | Earthquake alerts for a configured region (USGS API, defaults: California) |
|
|
|
|
## Enabling a plugin
|
|
|
|
1. Add or edit the plugin's section in `config.ini` (see each plugin's doc for options).
|
|
2. Set `enabled = true` for that plugin.
|
|
3. Restart the bot.
|
|
|
|
Some plugins require additional configuration (API keys, webhook URLs, etc.) before they will run successfully.
|