GeorgeChampBot

GeorgeChampBot, a multi-purpose discord bot

Getting Started

To get a copy of this project, install git, and then run the following command in the terminal:

git clone https://github.com/george-xiao/GeorgeChampBot.git

Change your directory in the terminal to the cloned project:

cd your/path/here

Copy the .env.template file to create a .env file, and fill in the .env. This will require you to set up the following:

• a Discord bot,
• Twitch Authentication Key,
• YouTube Authentication Key and
• Dedicated server channels and roles

Install Docker based on the platform the bot will run on.

Give the run.sh script permission to execute by running the following command in the terminal.

chmod +x run.sh

Finally, start the application using the run.sh script. Note that only this step is needed to start the bot on subsequent runs.

./run.sh

Run Manually

To run the bot directly on your local machine, the additional dependencies have to be installed (on top the ones installed in Getting Started).

sudo apt-get install -y python3 python3-dev python3-pip
pip3 install -r requirements.txt
sudo apt-get install ffmpeg

Use the following command to start the bot:

python3 GeorgeChampBot.py

Built With

• aiohttp - Asynchronous HTTP Client/Server for asyncio
• asyncio - write concurrent code using the async/await syntax
• collections - specialized container datatypes providing alternatives to Python’s general purpose built-in containers
• datetime - classes for manipulating dates and times
• discord.py - API wrapper for Discord
• dotenv - reads the key-value pair from .env file
• emoji - emojis for Python
• google-api-python-client - Google API Python client library for Google's discovery based APIs
• isodate - ISO 8601 date, time and duration parsing module
• math - mathematical functions defined by the C standard
• operator - set of efficient functions corresponding to the intrinsic operators of Python
• os - operating system dependent functionality
• PyNaCl - enables networking and cryptography operations
• python-twitch-client - Python library for accessing the Twitch API
• re - regular expression matching operations
• shelve - a persistent, dictionary-like object
• urllib3 - a powerful, user-friendly HTTP client for Python
• yt-dlp - youtube-dl fork with additional features and fixes

Authors

• George Xiao - george-xiao
• Symoom Saad - PSYmoom
• Maaz Mazharul - mmaaz1
• Steven Aung - teiian