Updated README2

This commit is contained in:
DeSqBlocki
2025-02-08 15:02:52 +01:00
parent d56a66a748
commit 8292db72e3
+23 -22
View File
@@ -1,35 +1,36 @@
# HelBot v5
## This Version of HelBot aims to clean up some background logic, directly tap into Helix API and mainly auto-renew tokens provided by Twitch.tv
HelBot v5 introduces an improved background logic structure, streamlined integration with the Helix API, and automated token renewal for Twitch.tv, ensuring a seamless experience for streamers and their communities.
### Database Structure:
client.credentials:
> _id
> client_id
> client_secret
> token
> service
> mod_id
shoutouts.#channel:
> _id
> user
> created_at
**client.credentials**:
- `_id`
- `client_id`
- `client_secret`
- `token`
- `service`
- `mod_id`
**shoutouts.#channel**:
- `_id`
- `user`
- `created_at`
### Chat Commands:
Update Chat Mode (Mods & Broadcaster only)
> $mode [on:off]
**Update Chat Mode** (Mods & Broadcaster only)
- `$mode [on:off]`
Get a random positive reminder (All)
> $positivity
**Get a Random Positive Reminder** (All)
- `$positivity`
View Donothon/Charity Event Infos
> $donate
**View Donothon/Charity Event Information**
- `$donate`
### Behaviour:
- Automatically protect chat by enabling follow/sub/emote only upon going offline
- Automatically shoutout VIPs when they write something in chat for the first time of this stream
- Automatically shoutout Raiders upon Getting Raided
- Respond to Messages inclunding Kaw, Caw or Kweh (Strict and Non-Strict Mode available)
- Automatically protects the chat by enabling **follow-only**, **sub-only**, or **emote-only** modes when the stream goes offline.
- Automatically shoutouts VIPs when they speak for the first time in the chat during a stream.
- Automatically shoutouts Raiders when getting raided.
- Responds to specific messages containing "Kaw", "Caw", or "Kweh", with **Strict** and **Non-Strict** modes available.