From d463f4656337710b10ab73e437a12c7e2674c8ed Mon Sep 17 00:00:00 2001 From: bryce Date: Sat, 5 Jul 2025 16:52:24 +1200 Subject: [PATCH] README.md Upadated Commands & Auto-Greetings modified --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 48f8168..2863219 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,29 @@ This bot is a CMDli or Terminal application that should run on most systems. The Theory is this should be a Light Weight application and to that point, it can only handle Text based (Chat) commands. +>[!NOTE] +>While there is a command response for greetings, the bot should greet every user upon FirstWords (of the stream). +>The bot sohuld also NOT greet userNames that are removed from chat via WizeBot. + + > ## The Commands it comes with: -> < > = optional Input || [ ] = Required Options +> < > = optional Input | [ ] = Required Options > ### MOD COMMANDS ONLY > !title - if no Input then it will post the current title to the chat +> > !category or !game +> > !so [@ChatName] - shoutouts given to the channel (this has a 1hr cooldown per @chatName - the file is "so_cooldown.json") +> > !cmd [add | del | edit | pause | resume] [!commandName] - Manage or Make a command (new commands will be marked with * in the list and have the Mod's Name (for streamer's reference)) > > ### ALL USERS > !hi, !hello, !gday, !hola, !kiaora <@ChatName> - if no chatName is given the bot will greet the user who used the command +> > !nextSong - request for the song to be skipped (if BG music is playing) this one plays a sound to alert the streamer as the bot doesn't have spotify integration (maybe in the future) +> > !AFOL - ID yourself as an AFOL (Adult Fan Of Lego) - this list will be saved to "AFOL.txt" for OBS / other reasons +> > !countdown [MM:ss] - starts a countdown timer in chat (updated every 30 seconds via New Message) for a max of 60 Minutes (1H:00M) - Channel Announcement in Orange once timer is up. +> > !cough [1-10/10]- you heard {$streamerName} cough on open mic ... Rate it 1 - 10 / 10 (anything over 10 is a coughing fit)