Skip to content

Latest commit

 

History

History
42 lines (35 loc) · 2.9 KB

README.md

File metadata and controls

42 lines (35 loc) · 2.9 KB
Raw

Update: This project is no longer supported. There's a newer, better one here.

This project began as a learning project. Part of that learning, for me, was relizing that my design got out of hand and became a nightmare to add features to in its current state. This monolithic design was fun to build, but I've moved to a microservice-based project with more robust features. You can find that project here. Currently, the new design is all Python and uses Docker and Docker Compose, which should make using it much easier.

Thank you for enjoying this project in its incomplete state. Feel free to star the new one and watch me build it on stream.

A Python-Powered Twitch Chatbot.

An all-in-one Twitch engagement and analytics project, built live on stream.

Just add your credentials and go.

✅ Requirements

  • Python 3
  • PostgreSQL

🤖 Using the bot

  1. Get a Client ID and Client Secret from Twitch.
  2. Get an Oauth token here.
  3. Fill credentials.env.sample with the above tokens, as well as the name of the bot and the channel it will join.
  4. Rename credentials.env.sample -> credentials.env
  5. Run pip install -r requirements.txt
  6. Run chat_bot.py.
  7. In Twitch chat, add, edit, or delete commands with !addcommand, !editcommand, or !delcommand respectively.

🖥 Data Gathering

The bot will store data in a PostgreSQL database called stream_data which is created by the bot at startup. It stores every message sent, and every command used. Additional insights about stream length, title, average viewership, new followers/subscribers, cheers, tips, and other data points are in the works.

🏡 Hosted Locally.

All of the data the bot gathers is stored locally. Keep in mind that no one can hide Twitch data from Twitch itself. Still, there is no need to rely on third party bots like StreamElements or StreamLabs to gain access to your chat data, and you won't have to slog through Twitch's terrible analytics. The data is all yours, in real time. Once the data viz app is constructed, there will be no programming knowledge required to get these insights.

🎥 Built On Stream

If you want to see the progress on this project being made live, feel free to come by my own Twitch channel to ask questions or comment on the code. When I'm offline, feel free to reach out on the Workshop Discord Server and offer up your questions, comments, critiques, or feature proposals. There are hundreds people in there who love to help give advice. It's a fun place that I'm proud of. Thanks, friends!