55 lines
2.6 KiB
Markdown
55 lines
2.6 KiB
Markdown
# Streambot_Twitch
|
|
#### (chatbot)
|
|
|
|
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.
|
|
|
|
>### CMDli interface / usage
|
|
> [ $twitchbot ] will start the bot and show bot:>
|
|
>
|
|
> the options you can use are:
|
|
>
|
|
> bot:>title [get|set] <newTitle> - view the Current Title or set a new one
|
|
>
|
|
> bot:>category [get|set] <category> - view the Current Category or set a new one
|
|
>
|
|
> bot:>list [categories|cmd] <permLevel> - catergories = view a list of categories from twitch | cmd <permLevel> = shows url for the commands list for that permission level or all commands if <premLevel> isn't specified
|
|
>
|
|
> bot:>stats [--watch | --interval=2m] - watch command usage & how many times the commands have been used in the lifetime of the bot
|
|
>
|
|
> bot:>uptime - shows your current stream uptime
|
|
>
|
|
> bot:>cmd [add|del|edit] [trigger] <response> (response only required if adding or editing a command)
|
|
|
|
>[!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
|
|
> !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")
|
|
>
|
|
> !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))
|
|
>
|
|
> ### 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)
|
|
>
|
|
> !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)
|