devchatter / devchatterbot

Chat Bot and Stream Overlay

Getting Started • Installing • Contributing • Contributors • License

Getting Started

This project is a place for us to have fun and build a chat bot together. It's currently just a console application, but later, we might add a GUI for local execution. I'm open to ideas about where we want to take this project. We could run it somewhere on the cloud, and we could decide that it needs a web interface. Let me know on-stream what you want to do.

Interested in joining a growing developer community? Connect with us on Discord! https://discord.gg/aQry9jG

Installing

These instructions will get you a copy of the devchatterbot up and running on your local machine for development and testing purposes.

Dependencies

• TwitchLib (nuget link) (GitHub)

Contributing

There are a few ways you can help, you can join us at DevChatter when we're streaming, you can report bugs or issues that you find, or you can suggest enhancements or changes.

Suggesting Enhancements

We are using GitHub Issues for our enhancement suggestions. Make sure to choose the correct label when creating the issue.

Bug Reporting

We are using GitHub Issues for our bug reports. Make sure to choose the correct label when creating the issue. Please include details of what you noticed as well as instructions for reproducing the issue. Please provide plenty of details to make it easier for us!

Sending Pull Requests

Details coming soon. Have I mentioned that you're awesome for even considering contributing to this project? Thanks!

Contributors

• AridTag
• DCurtin
• jdphenix
• asyncawake
• Mackiovello
• zultralord

License

This project is licensed under the MIT License - see the LICENSE file for details

devchatterbot's Issues

Add global command cool down

Add a configurable cool down for a user to running commands. Fractional seconds for the global. We just don't want someone to spam commands in chat.

Add restart command

Wouldn't it be nice to tell the bot to restart ? only from command line
it needs to close itself, open another process to build the app, and then start it again

Allow Command Aliases

Allow commands to be used with multiple command words. Not required for SimpleCommands.

Display Timestamp on all Console Messages

We should display a timestamp for all messages sent to the ConsoleChatClient, so that we can see when they were sent. This would be similar to how timestamps are common in other chat clients, like Twitch and Discord.

As part of this, we should remove the timestamp from the IntervalTriggeredMessage.

Stop Overusing SimpleCommand add new BaseCommand

SimpleCommand assumes it's just a text response. We usually don't use that. Let's start using an abstract BaseCommand that can Hand a CommandWord and IsEnabled check in one.

Update to Latest TwitchLib

We are on TwitchLib 1.6.1, but latest is 2.0.1 and likely has some breaking changes.

Add Informational Logging (Depends on #16)

Once the #16 issue has been set up, we should have a way of logging. Using that, we want to have an Information setting, which will have the bot log additional information about its running processes.

Add Hangman Game

Add a hangman game.

!hangman - starts new game using a random word (from internal list or internet)
!hangman a ask if "a" is in the word
!hangman apple guesses the word is "apple"

Abstract out the concept of a JoinableGame

For example Rock paper scissors has the concept of people choosing to join the game.

We're going to create a Heist game as well, so that we can see what's consistent, extract it, and test that portion separate from the rest of the join-able games.

Add command to give coins

Add an admin command to give coins to users.

Get full viewer list for currency updates

Found this online. Should see if twitch lib uses it somewhere already.
http://tmi.twitch.tv/group/user/CHANNELNAME/chatters

Add Heist Game to Bot

We should add a heist game that people can join in during chat.

**Commands: **
!heist - Starts or joins a heist, choosing a random role to assume.
!heist [role] - Starts or joins a heist, choosing a specific role to assume.

**Roles: **

• Grifter (100)
• Hacker (100)
• Hitter (100)
• Thief (200)
• Tech (150)
• Carrier (50)
• Driver (50)

**Possible Heists: **
We should choose from a random set of heists, where each one needs different roles more than others.

• Bank Robbery (Thief/Tech/Grifter, Driver, Carrier)
• Mob Bank Robbery (Thief/Tech/Grifter, Hitter, Driver, Carrier)
• Museum Heist (Thief/Grifter, Hacker, Carrier, Driver)
• Jewelry Store (Grifter/Hacker, Driver, Carrier)

Add command cool down

Adjust the interface to allow any given command to be able to have a cool down set, so it's not run too often. This should be optional in some way.

For example, we might want !hangman to only be started once every 15 minutes.

Each Module Should Wire Up Self

Each module should be responsible for wiring itself up.
For example, the Twitch module should wire itself up.
When added, the Discord module should as well.

Structure the configuration settings

The config settings are basically a list that now. Let's use the json structure to group them nicely using our settings classes.

Add user cool down

The same user shouldn't be sending the same command repeatedly. We should assign a value on each command and configure defaults for this.

Connect to Discord

The bot should be able to connect to Discord in order to send Interval messages and handle commands.

Add Schedule Command

Add a !Schedule command to the bot to display the regular schedule of the stream.

Would be nice if it converted to a requested timezone.

We started this last stream, but may want to switch to nodatime if it can handle it better. It should support .net standard.

Add basic error logging

We should add basic error handling and logging. The bot should continue running in nearly all cases of Exceptions.

Exceptions while running a command, sending or receiving messages, or getting API information should not crash the bot. Each of these should be logged and the bot allowed to continue running.

Allow Users to add SimpleCommands

Users should be able to add simple commands to the system.

In Hangman award points to anyone who contributed a letter.

Give some points to anyone who guessed a yet-unknown letter (per letter points)

Need to figure out how to handle HelpText for commands in the database

!help Magnus

That was broken on the stream, and that's because it's from the database. Probably need to update AddCommand to take in the HelpText and store it in the database.

Use Text Replacement Tokens for Most Commands

It would be nice if our commands had common text tokens that we could find in the response text.

Examples:

• {{UserDisplayName}} - Name of the user who issued the command.
• {{CommandName}} - This would be the command name itself.
• {{Arg0}} - Usage Example: !so DevChatter would yield "DevChatter"
• {{Arg1}} - Usage Example: !give Brendoneus 100 would yield "100"

Allow Hangman game to be lost

With enough wrong answers (noose, head, torso, arms, legs, lose). Game is lost when 6th bad letter is guessed.

New Followers Chat Announcement

Send message to corresponding chat announcing each new follower. Some of the relevant EventArgs pieces are set up but not completed for this.

RPS-Game: When there is no winner, display a more appropriate message.

Right now, when nobody wins, the bot displays the message: "The winners are !" . Another nice enhancement would be to change the message fromt the current "The winners are {name}!" to the more grammatically correct "The winner is {name}!" when there was only one winner :)

Fix the hastily synchronized code

Around the code, while on stream, we've put in some hastily-made hacks in order to "get things working". We should clean those up instead of just synchronizing the async code we called.

Clean Up Dependency Injection

Our current "poor man's dependency injection" approach isn't going to cut it much longer, we should rework it to better manage resources.

Add Quiz Questions

Should ask the question, then prompt over a time interval giving hints until someone guesses correctly.

!quiz attempt to start a game
!quiz join join the quiz game
!quiz leave forfeit the game
!quiz [a|b|c|d] make your guess

Add Quoting System

Depends on #30 for long-term storage. Can be built without, but not very useful. Add a command to add quotes, mods can use. Allow anyone to retrieve quotes randomly or by number.

Set up actual database

Set up a database and have entity framework core use it. Try too keep it simple so local still works while allowing for future application changes.

When Bad things happen show a quote instead

Add a feature to display a quote in chat instead whenever a command fails.

Idea from japperll

Add a help command

Add a help command for info. Have all IBotCommands be able to respond with a short info message.

!help - Gives general help info
!help lurk - gives info about the lurk command

Allow users to pass coins to eachother

Create !give command to give your own coins to someone else.

Examples:
!give person 10
!give @person 10

Make sure this doesn't allow negatives, because WhatDoesTheCowThink, Magnus, wheelspin, and some other people like to mess with the bot.

Show "Hype" on screen on command

Using the !hype command, spam hype emotes in chat and display the emote on screen.

In Hangman end game when all letters known

Game should end when last letter is guessed

Add Expected Command Arguments

Commands are triggered based on the CommandWord only. We should have expected arguments for commands. This would also mean that !so and !so DevChatter could be handled differently, since the former needs to do a random selection based on an API call and the latter does a simple text replacement.

Add in Achievements for Chatters/Viewers

For a long time we've been planning on having viewers and chatters be able to earn achievements through their participation in the stream. This will likely need some on-screen support, but we can start building it.

Should Show Word After Losing in Hangman

As CrimsonGreen mentioned on stream today, we should show the word after we die. Or you could just not die in the game.

Customizable Command Words

Right now, command words are hardcoded into each command instance. Abstract away command word resolution, to allow support for globalization for command words and allowing users to add their own words to existing commands.

Thought about this looking at #96

Make commands be case-insensitive

!twitter and !TwiTTer should both work just fine. This will mean that we need to handle the casing in a few places.

Create .editorconfig and .gitattributes

It would be helpful if .editorconfig and .gitattributes files were created to help maintain a consistent coding style

Hangman game should use a full library of words

It's using my hard-coded collection of words right now, and should have a file or database full of them.

!cmd

!cmd should be equivalent to !commands

Add IsEnabled property to IBotCommand

Should add an IsEnabled (or similar) property to IBotCommand so commands can be registered automatically while retaining the ability to turn specific commands off.

As mentioned on todays stream (2018-04-03)

(The readme mentions that you should make sure to assign the proper label but it looks like non maintainers are unable to do that. Should be flagged as enhancement probably)

Add and Remove Commands should happen without restart

Right now the AddCommandCommand and RemoveCommandCommand change the database, but the CommandHandler is using a static collection, so these don't affect the bot at runtime.

Add an !Uptime command

We should have an !uptime command that will return the amount of time the stream as been live.

Leverage the TwitchLib.Api services for this. It should have TwitchLib.Api.Sections.Streams.V5.GetUptimeAsync(string channelId)

Add !streams command

Add !streams command that can be used to highlight other streams.

maybe if !so is used add that stream to the list that is displayed when !stream is called?

For DevChatter; for example, maybe other C# streams.

This may help to grow the c# community on twitch by promoting other C# streamers.

Console Application Should Wait for Input

Instead of our existing infinite loop, we should put the IntervalTriggeredMessages on their own thread, leaving the console application available to respond to user input. As part of this, we should set up an "exit" command to turn the bot off instead of requiring Ctrl + c as we do now.

Rock Paper Scissors Game

Make a game where everyone is prompted to play, costs "tokens" if lose and gains "tokens" if win. Will require "tokens" and database permanence.