Readme.md update

added more commands to the suite that it comes with
- streamer / Broadcaster cmds
- VIP cmds
- Moderator cmds
- everyone cmds

included several mini games
- dice
- roulette
- ispy
- poker
- 8ball

added a points system

README.md

@@ -5,8 +5,15 @@ 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]
+>Key for entire document:
+>[required] - you must use one of these
+>
+><optional> - this only needed with certain [required]
+
+
 >### CMDli interface / usage
-> [ $twitchbot ] will start the bot and show bot:>
+> $twitchbot will start the bot and show bot:>
 >
 > the options you can use are:
 >
@@ -21,34 +28,84 @@ The Theory is this should be a Light Weight application and to that point, it ca
 > bot:>uptime - shows your current stream uptime
 >
 > bot:>cmd [add|del|edit] [trigger] <response> (response only required if adding or editing a command)
+>
+> bot:>notif [get|set] <newMessage> - view or set the notification message
 
 >[!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:
-
->[!NOTE]
->< > = optional Input | [ ] = Required Options
-
-> ### MOD COMMANDS ONLY
+> ### Broadcaster Commands (chat)
+> @bot [mute|unmute]
+>
+> !fav [cmd|user] <trigger|username> - Username HAS to be in chat during the current stream
+>
+> ^rec [name - start|end] - posts an Announcement (ORANGE) to Chat reading <"Recording Started (Ended) at [timestamp] [name]>" and sets a stream marker with the title
+>
+> !upcoming [event details] - set or view a message with details of the next event happening on the channel
+>
+> !countdown or !timer [duration (HH:mm)] - set a timer to countdown for the set duration (updates every 5mins if time is over 30mins; then 3mins if time is 30mins or less; then 1min if time is 15mins or less; then 30sec until 00:00)
+>
+> ### VIP Commands incl. Artist
+> !quoteme [quote] - saves a quote and can recall a random quote or a specific quote using [!quoteme #00000]
+>
+> !lfg - posts a message letting chat know you are pumped and ready to rock 'n roll
+>
+> !ispy - starts a random VIP only game of the classic I-spy (rounds last 3mins)
+> [VIPs use !guess [thing|emote|word] to guess (1st correct answer wins 100 points)]
+>
+> ### MOD COMMANDS
 > !title <New Stream Title> - if no Input then it will post the current title to the chat
 >
 > !category or !game <Twitch Category>
 >
 > !so [@ChatName] - shoutouts given to the channel (this has a 1hr cooldown per @chatName - the file is "so_cooldown.json")
 >
+> !tso [@ChatName] - uses the twitch "/shoutout" to shout out a user - Cooldowns are managed by Twitch.tv (Can also be triggered by using "/shoutout in chat")
+>
 > !cmd [add | del | edit | pause | resume] [!commandName] <command response message> - Manage or Make a command (new commands will be marked with * in the list and have the Mod's Name (for streamer's reference))
 >
+> !note [mods|caster] [message] - send Broadcaster (caster) or the other Mods a quick note in the respective private discord|whatsapp|element(matrix)|whisper or other msg channels
+>
+> !clip - creates a 30sec clip of what you just saw and posts it to #twitch-clips in discord
+>
+> !flag [username] - flag a user as suspicious (self deletes) reply = @user your wish has been carried out with precision
+>
+> !unflag [username] - remove flag from username (self deletes) reply = same as !flag
+>
+> !to or !timeout [user] [duration] - timeout a user in chat
+>
+> !cancel [to|timeout] [user] - cancel a timeout for user
+>
+> !warn [user] [reason] - give a warning to a user (logs # of warnings user recieved)
+>
+> !ban [user] [reason] - ban a user from chat - PLS leave a reason damnit
+>
+> !unban [user] [reason] - unban a user - reason is mandatory here
+>
 > ### ALL USERS
 > !hi, !hello, !gday, !hola, !kiaora <@ChatName> - if no chatName is given the bot will greet the user who used the command
 >
 > !uptime - How Long has {$streamerName} been Live?
 >
-> !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)
+> !nextSong - request for the song to be skipped (if BG music is playing) - sends chat Message - 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)
+>
+> !hug [user] - give another viewer a hug
+>
+> !dice or !roll - rolls a 6-sided dice gives random number between 1 & 6
+>
+> !8ball [question] - ask 8ball a question and recieve a totally random answer
+>
+> !roulette or !spin [points] [color] [number] - spin the roulette wheel & 2x your bet if your color and number are correct
+>
+> !slots or !pull [points] - spin the slot machine - 3 of a kind wins up to 5x your bet
+>
+> !poker or !table [points] - be the closest to 21 and win 2x your bet
+>
+> !points - check how many points you have [useful for !dice, !roll, !roulette, !spin, !slots, !pull, !poker or !table]