mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-10-03 12:57:53 +00:00
Gerard Hickey
0fe22d2b4f
* docs: Documentation for developing local commands Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Updated for developing using the local directory Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Minor updates and corrections Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Implementing recommendations from agessaman Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Update CHANGELOG.md Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> --------- Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
2.5 KiB
2.5 KiB
meshcore-bot Documentation
Documentation for the MeshCore bot: setup, configuration, commands, and services.
New to the project? Start with Getting Started.
Project overview
- README – Getting started, installation, quick start
- Command Reference – Full command reference
- Docker deployment – Docker deployment
- Service installation – Systemd service setup
- Web Viewer – Web viewer module
- Upgrade guide – What changes between releases, and how to upgrade
- FAQ – Common problems and fixes
Configuration
| Document | Description |
|---|---|
| Configuration | config.ini structure and command options |
| Path Command | Path command presets and tuning |
| Config validation | Validate config.ini before starting the bot |
| Data retention | How long the bot keeps captured data |
| Local plugins and services | Add your own commands and services |
| Check-in API | Submit check-ins to an external web API |
Guides
| Document | Description |
|---|---|
| Repeater Commands | Repeater management DM commands |
| Feed Management | RSS/REST feeds and posting to channels |
| Web Viewer | Web-based data viewer and API |
| Custom command website | Generate an HTML command reference for your users |
| Develop commands | Guide for developing bot commands |
Service Plugins
| Document | Description |
|---|---|
| Service Plugins overview | Enable and configure background services |
| Discord Bridge | One-way bridge to Discord |
| Telegram Bridge | One-way bridge to Telegram |
| Earthquake Service | Scheduled earthquake alerts from USGS |
| Packet Capture | Packet capture and MQTT |
| Map Uploader | Uploading to map.meshcore.dev |
| Weather Service | Scheduled weather and alerts |
| Repeater Prefix Collision Service | Detect repeater prefix collisions |
| World Cup | World Cup command and live match announcements |