chr-1x / hmh_bot

Python modules for the Willie IRC bot used in the Handmade Hero twitch chat.

hmh_bot

Python module for the Willie IRC bot used in the Handmade Hero twitch chat.

Custom commands are defined in handmade.py, handmade_faq.py, handmade_stream.py, and handmade_bonus.py. handmade.py should be reserved commands related to the bot functionality, handmade_faq.py for common stream questions, handmade_stream.py for stream scheduling and timing based functions, and handmade_bonus.py for easter eggs and miscellaneous commands.

The config options used by the bot are available in handmade.cfg. Please refer to the Willie documentation for what the common configuration options mean.

test.py is currently deprecated, it might be useful at some point in the future to attempt to set up a series of tests to run to ensure the bot remains working.

Please refer to the forum thread and Issues page for discussion about features to add and updates.

Installation

• Clone the repository and cd into the directory.
• Read through sampleconfig.txt and fill in necessary information
• Rename the config file, e.g. handmade.cfg
• Run willie -c handmade.cfg to start the bot.

Important: Please make sure that there is not already an instance of ChronalRobot running in chat. Twitch will not prevent multiple of them from running at a time, and all active instances will attempt to respond to queries. An easy way to test for this is to use the !hello command, as this should always be available. (Note: as of recently, the default bot username is now hmh_bot. You can run your own instance alongside if you change the username, oauth, and command character for the bot.)

If you should need to find out who is running a particular instance of the bot, use !owner in chat.

For help setting up the config, have a look at Setup.md

Libraries

Robot requires the following libraries to be installed: willie, arrow, parsedatetime, and sqlobject

To install them, issue following command:

sudo pip install willie arrow parsedatetime sqlobject

NOTE: WILLIE became SOPAL(https://github.com/sopel-irc/sopel) we are not upgrading for the time being

hmh_bot's Issues

FAQ For "how can I support the game/stream/project"

Links to buy the game, donate to patreon

Specify timezones for !schedule command (default output)

People are lazy

Bot intreprets "12/23" as "12/23/2015"

parsedatetime assumes the date is the next occurrence even if its almost a year later.

Make !o/ and !\o/ greetings command

The o/ and \o/ are already a thing between some of us, so we can have !o/ as a greeting to a specific person and then !\o/ for it to say greetings to everyone on the behalf of the one typing the command.
So the person joining will do !\o/ and people will respond with !o/

Q & A Question Management

Implement a system where the bot can filter questions for Q&A tag, submit them to a moderation system, and then display them during Q&A.

Exception while executing !schedule command

Bot shows following, instead of proper information:

TypeError: can't subtract offset-naive and offset-aware datetimes (file "/home/pi/.willie/modules/handmade_stream.py", line 94, in getTimestamp)

Conditionally enable modules/commands based on proximity to stream time

This could happen in response to time or in response to irc user count.

Bot tries to schedule the stream at the "usual" time even if a schedule is set under some conditions

Noticed Friday, 12/26 when the stream was scheduled for 10am and the bot tried to set it to 11am

Suspected reason: No next stream explicitly scheduled (it's a Friday) so it defaults to 11am and the mechanism to check if there's already been a stream today doesn't take into account alternate schedules.

Time-based reminders

There have been requests for a number of different time-based reminder sequences:

• Periodically display Q&A information during Q&A sessions
• Show stream start reminders
• Show bot info periodically during streams

Feature needed: Standard system for scheduling time-based events

Bot intreprets "today" in UTC

Bot is inconsistent about tense, and since most of the rest of the bot is running in PST, schedule should behave the same.

Limited what commands show in !list that do the same thing

so talking with @mvandevander and @abnercoimbre on irc and we thought it would be nice to not have the !list command show all the aliases for the same command.

I mentioned maybe doing a manual list command. but that would require us to update it when we add new commands.

since we already have hide=true. maybe we could use that in a way to say hide all but the first alias. then we could only show 1 command.

!schedule default output (current week) does not reflect sub-hour stream variance

Behavior for this should probably be to print out only the hour (current behavior) if stream is happening exactly on the hour, else print out the hour:minute (8:30 PM for example)

Bot spat out error if passed name in !schedule

Check case handling

Schedule Setting from CSV

https://forums.handmadehero.org/index.php/forum?view=topic&catid=5&id=65

handmadehero.org/broadcast.csv is what Casey has done to put the schedule in one place for us and him. So at some point we should look at parsing the csv and updating the DB from it.

Move ChronalRobot to willie 5.0.0

I'm not sure if Willie 5.0.0 broke anything yet, but it would be nice to move to the new versions just because it makes db access nicer.

Update ReadMe for required libraries.

I had to install pytz and parsedatetime:
sudo pip install pytz
sudo pip install parsedatetime

Quote module: removing/managing quotes

No way to remove accidentally mistyped or misattributed quotes without going into the DB

Quote Module: Add quote attributions

as chronal mentioned in #31

relative dates ("today", "tomorrow", "monday", etc) are relative to -6 months ago

Need different context for inferred years and inferred days, somehow

Quote module: editing quote content/time

Missing feature

FAQ for "how long will the game take"

Stream scheduling system [In Progress]

Command based (and maybe config-based)