mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-05-11 18:14:50 +00:00
agessaman
a60b35f567
- Removed caution section from README to streamline information. - Added new services to README: Earthquake Service, Repeater Prefix Collision Service, and MQTT Weather Relay. - Expanded command reference documentation with new commands: `version`, `status`, `aurora`, `magic8`, `catfact`, `reload`, `channelpause`, `channelresume`, `greeter`, `announcements`, and `schedule`. - Updated getting started guide to reflect changes in Python version requirement and installation instructions. - Enhanced service plugins documentation to include new services and clarify existing ones.
1.9 KiB
1.9 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
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 |
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 |
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 |