updated README

This commit is contained in:
DeSqBlocki
2025-02-13 21:09:40 +01:00
parent 85f031c33a
commit 29f6c0cca1
+22 -11
View File
@@ -5,34 +5,45 @@ HelBot v5 introduces an improved background logic structure, streamlined integra
### Database Structure: ### Database Structure:
**client.credentials**: **client.credentials**:
- `_id` - `client_id` (twitch:discord)
- `client_id` - `client_secret` (twitch:discord)
- `client_secret` - `token` (access_token:token)
- `token` - `service` (twitch:discord)
- `service` - `mod_id` (twitch only)
- `mod_id`
**shoutouts.#channel**: **shoutouts.#channel**:
- `_id`
- `user` - `user`
- `created_at` - `created_at`
**guilds.id**: **guilds.id**:
- `_id` - `event`
- `settings` - `channel`
- `channels`
**commands.channel**:
- `name`
- `enabled`
**settings.channel**:
- `name`
- `enabled`
### Chat Commands: ### Chat Commands:
**Update Chat Mode** (Mods & Broadcaster only) **Update Chat Mode** (Mods & Broadcaster only)
- `$mode [on:off]` - `$mode [on:off]`
**Get a Random Positive Reminder** **Get A Positive Reminder**
- `$positivity` - `$positivity`
**View Donothon/Charity Event Information** **View Donothon/Charity Event Information**
- `$donate` - `$donate`
**View / Manage Settings**
- `$commands [enable:disable] [setting]`
**View / Manage Commands**
- `$commands [enable:disable] [command]`
### Behaviour: ### Behaviour:
- Automatically protects the chat by enabling **follow-only**, **sub-only**, or **emote-only** modes when the stream goes offline. - Automatically protects the chat by enabling **follow-only**, **sub-only**, or **emote-only** modes when the stream goes offline.