README.md

EngBuddy

Authors: Sahaj Singh

EngBuddy is your personal engineering assistant available 24/7 on the ESSS Discord server. With its advanced AI capabilities, EngBuddy provides personalized support to help you succeed in your studies and build meaningful connections with your peers.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Key Features
  • Question and Answer
  • Custom Image Generation
  • Course Information and Outline
  • Professor Ratings
  • Course Ratings
  • RetroPie Arcade Integration
• Additional Features
  • Ephemeral Messages
  • Direct Messaging (DM) with EngBuddy

Follow these steps to set up the project on your local machine for development and testing purposes. To start using EngBuddy on the ESSS Discord server, simply join the server and start using the slash commands to access the features described above.

Prerequisites

Ensure that you have the following software installed on your machine:

• Python 3.6 or higher
• pip (Python package manager)

Installation

1. Clone the repo

git clone https://github.com/your_username/Algorithm-Visualizer.git

2. Install the required packages

Navigate to the project directory and run:

pip install -r requirements.txt

Key Features

EngBuddy offers the following features to help you with your engineering studies:

1. Question and Answer (/ask *args)

Have a question about engineering or your studies? EngBuddy can provide you with detailed answers using the ChatGPT integration. Just ask your question using the slash command and EngBuddy will respond with an answer.

2. Custom Image Generation (/imagine *args)

Need a visual representation of a concept or idea? EngBuddy can generate images based on your description using DALL-E v2 integration. Describe what you want, and EngBuddy will create an image to match your request.

3. Course Information and Outline (/sfu *args and /outline *args)

Looking for information on specific SFU courses? EngBuddy can provide you with course details and outlines using the Course Outlines REST API. You'll have access to important course information with just a simple slash command.

4. Professor Ratings (/rate_prof *args)

Want to know how other students rate a particular professor? EngBuddy can retrieve ratings for SFU professors by scraping data from ratemyprofessors.com, giving you insights into the professor's teaching style and effectiveness.

5. Course Ratings (/rate_course *args)

Curious about the overall rating of a specific course? EngBuddy can provide you with course ratings by scraping data from the coursediggers website and extracting information from an SQLite database. This helps you make more informed decisions about your course selections.

6. RetroPie Arcade Integration (In Progress)

EngBuddy is working on a new feature to show active games running on RetroPie arcade systems. This will inform users about the currently played game and whether or not the arcade is in use, allowing you to join in on the fun or know when it's available.

Additional Features

Ephemeral Messages

To reduce bot clutter in the server, EngBuddy uses ephemeral messages. These messages are only visible to the user who invoked the command, ensuring a cleaner chat experience for everyone.

Direct Messaging (DM) with EngBuddy

Need more personalized assistance or prefer a one-on-one conversation? You can directly message EngBuddy on Discord and chat with it using the ChatGPT integration. Just send a DM to EngBuddy and start asking your questions.

Contributing

If you would like to contribute to the development of EngBuddy, please feel free to fork the repository and submit a pull request. We welcome any ideas and improvements to make EngBuddy even more useful for engineering students.