From d56a66a748f31baf65f777579dc37b3232e6b7d8 Mon Sep 17 00:00:00 2001 From: DeSqBlocki Date: Sat, 8 Feb 2025 15:01:35 +0100 Subject: [PATCH] Updated README --- README.md | 39 +++++++++++++++++++++++++++++++-------- 1 file changed, 31 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d533dfc..e8cc7b9 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,35 @@ # HelBot v5 -## This Version of HelBot aims to clean up some background logic and mainly auto-renew tokens provided by Twitch.tv +## 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 -### Planned Features: -Access Tokens: -- now stored in DB -- reacts to 401 response to refresh token +### Database Structure: +client.credentials: +> _id +> client_id +> client_secret +> token +> service +> mod_id -Chat: -- Chat Mode on:off -- Respond to Kaw, Caw & Kweh! \ No newline at end of file +shoutouts.#channel: +> _id +> user +> created_at + +### Chat Commands: + +Update Chat Mode (Mods & Broadcaster only) +> $mode [on:off] + +Get a random positive reminder (All) +> $positivity + +View Donothon/Charity Event Infos +> $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) \ No newline at end of file