Getting Started

Sonny is a chatbot built with Python, TwitchIO, hosted on Heroku, and named and inspired by the Sonny character from the “I, Robot” movie of 2004, and used on my Twitch channel.

Quick Start

Clone the repository

Open your terminal and run the following command:

Terminal

git clone https://github.com/Superp0sit1on/sonny.git

Install the dependencies

On the terminal, navigate to the project’s root directory and run the following command:

Terminal

pipenv install

Setup the environment variables

Create a .env file in the root directory with your chatbot credentials and definitions. Example:

.env

TOKEN=oauth:****
NICKNAME=chatbot_username # Your Twitch channel if it doesn't have a separate chatbot account
CHANNELS=your_channel
BOTS=example_bot, another_example_bot

Note

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

Run the local environment

On the terminal, run the following command:

Terminal

pipenv run bot

Caution

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

Next Steps

• Project Structure: Learn how the project is structured in “Project Structure”.
• Commands: Learn how to write your own commands in “Writing Commands”.
• Modules: Learn how to manage modules in “Managing Modules”.
• Deploy: Publish your chatbot on Heroku with the “Deploying to Heroku” guide.
• Document: Learn how to manage and write the chatbot documentation in “Documenting”.
• Contribute: Get to know how to contribute to the project in “Contributing”.

Troubleshooting Sonny

You can create a new issue on the GitHub repository or chat with us on our Twitch channel if you encounter any problems with the documentation or the project itself.