Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shivan-s/cigargary-bot
A bot for cigargary's twitch and discord?
https://github.com/shivan-s/cigargary-bot
bot discord python twitch twitter
Last synced: about 2 months ago
JSON representation
A bot for cigargary's twitch and discord?
- Host: GitHub
- URL: https://github.com/shivan-s/cigargary-bot
- Owner: shivan-s
- License: mit
- Created: 2021-09-19T10:01:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-06T09:29:18.000Z (about 3 years ago)
- Last Synced: 2024-10-23T22:19:16.601Z (3 months ago)
- Topics: bot, discord, python, twitch, twitter
- Language: Python
- Homepage:
- Size: 59.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cigargary-bot
This is a bot created for [cigargary's twitch](https://www.twitch.tv/cigargary)
Please log ideas and problems in the [issues pages](https://github.com/ShivanS93/cigargary-bot/issues)
## 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`
```shell
pip install pre-commit
pre-commit install
```
2. Set up `pipenv`
```shell
pip install pipenv
pipenv lock
# enter the shell to run code
pipenv shell
# or use pipenv run
pipenv run blah
```
2. Set up a twitch bot token (see below)
3. 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:
CLIENT_ID=
BOT_NICK=
BOT_PREFIX=! # the prefix, normally '!'
CHANNELS=
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 .env portion
DISCORD_TOKEN=
DISCORD_GUILD=cigargary
```
3. TODO: Consoldate this with twitch .env files settings