docs: update README and command reference with new features and services

- 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.
This commit is contained in:
agessaman
2026-04-25 19:21:23 -07:00
parent dbc07880ee
commit a60b35f567
6 changed files with 162 additions and 10 deletions
+146 -2
View File
@@ -97,6 +97,32 @@ cmd
---
### `version`
Show the bot's current software version.
**Usage:**
```
version
```
**Response:** Version string for the running MeshCore bot build.
---
### `status`
Show current bot and radio status details.
**Usage:**
```
status
```
**Response:** Runtime status summary (connection/health information).
---
## Information Commands
### `channels`
@@ -302,6 +328,20 @@ sun
---
### `aurora`
Get aurora visibility/forecast conditions for configured or provided coordinates.
**Usage:**
```
aurora
aurora <lat>,<lon>
```
**Response:** Aurora activity and visibility guidance for the requested location.
---
### `moon`
Get moon phase information and moonrise/moonset times for the bot's configured location.
@@ -498,6 +538,25 @@ roll 1000
---
### `magic8`
Ask the Magic 8-Ball a yes/no question.
**Usage:**
```
magic8 <question>
```
**Examples:**
```
magic8 will the mesh be busy tonight?
magic8 should I deploy another node?
```
**Response:** A randomized Magic 8-Ball style answer.
---
## Entertainment Commands
### `joke`
@@ -557,6 +616,19 @@ ls -l /secret/base
---
### `catfact`
Get a random cat fact.
**Usage:**
```
catfact
```
**Response:** A short random cat fact.
---
## Sports Commands
### `sports`
@@ -683,8 +755,6 @@ mt
**Response:** List of all unique routing paths discovered during the 6-second listening period.
---
## Command Syntax
### Prefix
@@ -847,6 +917,50 @@ advert
---
### `reload`
Reload supported runtime configuration without restarting the bot.
**Usage:**
```
reload
```
**Response:** Confirms reload success or reports validation/loading errors.
**Note:** Admin DM command. Connection/radio settings still require a process restart.
---
### `channelpause` / `channelresume`
Temporarily pause or resume bot reactions on public channels.
**Usage:**
```
channelpause
channelresume
```
**Response:** Confirms whether channel handling is paused or resumed.
**Note:** Admin DM command. DMs continue to work while channel responses are paused.
---
### `greeter`
Show greeter behavior and configuration guidance.
**Usage:**
```
greeter
```
**Response:** Describes greeter mode and points to `[Greeter_Command]` settings in config.
---
### `feed`
Manage RSS feed and API feed subscriptions (Admin only).
@@ -882,5 +996,35 @@ feed test https://example.com/feed.xml
---
### `announcements`
Manage announcement ACL and related announcement settings.
**Usage:**
```
announcements <subcommand> [args]
```
**Response:** Shows current announcement ACL or confirms changes.
**Note:** Admin access required.
---
### `schedule`
View configured scheduled messages and advert interval.
**Usage:**
```
schedule
```
**Response:** Lists upcoming scheduled posts and current advert timing.
**Note:** DM-only command by default.
---
For more information about configuring the bot, see the main [README](https://github.com/agessaman/meshcore-bot/blob/main/README.md) file.