cigargary-bot

This is a bot created for cigargary's twitch

Please log ideas and problems in the issues pages

Plan

0. Write tests
1. Twitch bot that responds to commands like !project, !devops
2. Link twitch to discord to tell discord when cigargary is live?

Getting started

1. Set up pre-commit

   pip install pre-commit
   pre-commit install
   

2. Set up pipenv

   pip install pipenv
   pipenv lock
   
   # enter the shell to run code
   pipenv shell
   
   # or use pipenv run
   pipenv run blah
   

3. Set up a twitch bot token (see below)
4. Run the bot

   # from root of the project directory
   pipenv run start
   

[HOSTING]

The bot is hosted on Heroku. We are yet to write documentation about this.

[TWITCH] How to generate a token for the twitch bot

Documentation on twitchio library: https://pypi.org/project/twitchio/

1. Logout of current twitch account
2. Create a bot twitch account
3. Create a token: https://twitchtokengenerator.com/
4. Add tokens in an .env file

   # .env
   ACCESS_TOKEN=oauth:<ACCESS TOKEN>
   CLIENT_ID=
   BOT_NICK=<bot's nickname>
   BOT_PREFIX=! # the prefix, normally '!'
   CHANNELS=<channels to join>
   
   FRESH_TOKEN=
   

[DISCORD] Setting up discord bot

Resources:

• https://pypi.org/project/discord.py/
• https://realpython.com/how-to-make-a-discord-bot-python/

1. Create a bot account and get tokens (see resouces above) TODO: write 1. Create a bot account and get tokens (see resouces above) TODO: write1. Create a bot account and get tokens (see resouces above) TODO: write this
2. Add below to .env file

   DISCORD_TOKEN=
   DISCORD_GUILD=cigargary
   

3. TODO: Consoldate this with twitch .env files settings