mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-05-24 08:15:18 +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.
43 lines
1.9 KiB
Markdown
43 lines
1.9 KiB
Markdown
# meshcore-bot Documentation
|
||
|
||
Documentation for the MeshCore bot: setup, configuration, commands, and services.
|
||
|
||
**New to the project?** Start with [Getting Started](getting-started.md).
|
||
|
||
## Project overview
|
||
|
||
- [README](https://github.com/agessaman/meshcore-bot/blob/main/README.md) – Getting started, installation, quick start
|
||
- [Command Reference](command-reference.md) – Full command reference
|
||
- [Docker deployment](docker.md) – Docker deployment
|
||
- [Service installation](service-installation.md) – Systemd service setup
|
||
- [Web Viewer](web-viewer.md) – Web viewer module
|
||
|
||
## Configuration
|
||
|
||
| Document | Description |
|
||
|----------|-------------|
|
||
| [Configuration](configuration.md) | config.ini structure and command options |
|
||
| [Path Command](path-command-config.md) | Path command presets and tuning |
|
||
| [Config validation](config-validation.md) | Validate config.ini before starting the bot |
|
||
|
||
## Guides
|
||
|
||
| Document | Description |
|
||
|----------|-------------|
|
||
| [Repeater Commands](repeater-commands.md) | Repeater management DM commands |
|
||
| [Feed Management](FEEDS.md) | RSS/REST feeds and posting to channels |
|
||
| [Web Viewer](web-viewer.md) | Web-based data viewer and API |
|
||
|
||
## Service Plugins
|
||
|
||
| Document | Description |
|
||
|----------|-------------|
|
||
| [Service Plugins overview](service-plugins.md) | Enable and configure background services |
|
||
| [Discord Bridge](discord-bridge.md) | One-way bridge to Discord |
|
||
| [Telegram Bridge](telegram-bridge.md) | One-way bridge to Telegram |
|
||
| [Earthquake Service](earthquake-service.md) | Scheduled earthquake alerts from USGS |
|
||
| [Packet Capture](packet-capture.md) | Packet capture and MQTT |
|
||
| [Map Uploader](map-uploader.md) | Uploading to map.meshcore.dev |
|
||
| [Weather Service](weather-service.md) | Scheduled weather and alerts |
|
||
| [Repeater Prefix Collision Service](repeater-prefix-collision-service.md) | Detect repeater prefix collisions |
|