Skip to content

README.md

Latest commit

 

History

History
48 lines (39 loc) · 1.82 KB

README.md

File metadata and controls

48 lines (39 loc) · 1.82 KB

Quizzly Bear - Python Discord Codejam Project

Welcome to the GitHub repository for Quizzly Bear, a Discord bot created for the Python Discord Summer CodeJam 2024! This bot is based on the theme "Information Overload", where its plethora of interactive and informative features fit right in.

Quizzly bot has the following slash commands

  • discuss to create a discussion on a given topic
  • summarize to summarize a given body of text
  • shortify to summarize the conversation in-between two messages
  • factpedia to start a fact checker minigame
  • hello to generate a simple greeting :)
  • ping to ping the bot
  • randomize to tag a random user
  • score to fetch the user score
  • leaderboard to display the server leaderboard
  • quiz to start a new quiz

Check out this presentation for a glimpse of the commands at work!

Installation and Running

  1. Create a bot account.

  2. Clone the repo.

git clone https://github.com/13acts/Code-Jam-2024.git
  1. Enter directory, install poetry, and do poetry install to install all the project dependencies. Skip step 2 if you already have poetry installed on your system.
cd Code-Jam-2024
python -m pip install poetry
poetry install
  1. Activate .venv
poetry shell
  1. Create an .env file with environment values set as in the .env.sample file.
  • TOKEN: Discord Bot Token
  • SERVER: Discord server ID (used for development only)
  • DATABASE: Connection to MongoDB
  • GOOGLE_API_KEY: API Token from Google Gemini
  1. Run the bot.
python main.py