Skip to content

🤖 Always on chatbot of my Twitch channel

License

Notifications You must be signed in to change notification settings

Superp0sit1on/sonny

Repository files navigation

Sonny 🤖

Twitch · Documentation

Chatbot named and inspired by the Sonny character from the "I, Robot" movie of 2004, and used on my Twitch channel.

Animated gif of the chatbot running on Windows Terminal

 

✨ Features

  • List of commands: provide a list of available commands to the chat using !cmd.
  • Commands module: create custom commands to interact with the chat.
  • Greetings module: automatically welcomes viewers to the chat.
  • Pride module: bunch of commands to celebrate the LGBTQIA+ community with their flags.
  • Stylished logs: use colored logs to improve readability and debugging.
  • Modular design: separate the bot's features into modules for better organization and maintenance.
  • Code formatting and linting: maintain the codebase clean and organized using Black and iSort.
  • Environment variables: store sensitive information in a .env file for security.
  • Heroku deployment: deploy the chatbot to Heroku for continuous operation.
  • Documentation: provide a detailed explanation of the chatbot's features and usage.

 

🧰 Requirements

 

🛠 Usage

  1. Clone the repository:
git clone https://github.com/Superp0sit1on/sonny.git
  1. Install the dependencies:
pipenv install
  1. Create a .env file in the root directory with your chatbot credentials and definitions. Example:
TOKEN=oauth:****
NICKNAME=s0nny_bot
CHANNELS=superp0sit1on
BOTS=streamlabs, pokemoncommunitygame

Tip

You can get your chatbot token from the Twitch Apps TMI website.

  1. Run the local environment:
pipenv run bot

Important

Don't forget to grant mod privileges with /mod nameofyourbot to your chatbot on your Twitch channel if it runs under a different account.

 

🚀 Deploy

Currently hosted on Heroku and running 24/7, you can check our Heroku deployment documentation for more info on how to deploy the chatbot to Heroku.

 

✍️ Issues

Feel free to open an issue if you find a bug or have a suggestion.

Important

Fill out the issue template accordingly for accurate and faster responses.

 

👐 Contributing

See CONTRIBUTING.md.

 

📜 Code of Conduct

See CODE_OF_CONDUCT.md.

 

🔗 Links

 


Copyright © 2024 Júlio Martins