README.md

Baymax

The official discord bot of TinkerHub NSSCE

Report a Bug · Request feature

Baymax is the official Discord bot of TinkerHub NSSCE, designed to manage the server effectively and efficiently while also keeping it lively by engaging in natural conversations with users.

Overview

Baymax was developed in an effort to automate and streamline the onboarding process to TinkerHub NSSCE's discord server providing the members an easier and quicker way to get themselves verified and gain complete access to the server. But it doesn't stop there, Baymax is capable of much more🔮

Here's what Baymax can do :-

• He can send you a greeting message on joining the server with steps to onboard the server
• He can detect once you've succesfully onboarded and assign appropriate roles and a nickname
• He sends out a beautiful image with your discord avatar and nickname once onboarded
• He can answer your common queries regarding onboarding
• He has answers to common questions regarding TinkerHub
• He is self-aware and can provide answers to questions about himself
• He can do a lot of small talk, try asking him for jokes
• He can lighten you up with inspiring quotes if you're feeling down
• He can find the latest hot news in tech and deliver them directly to the server

Well there certainly is a lot more he can do, if you're curious then you can find out for yourself by joining our server here 👉 https://discord.gg/2bBPbdRud6

How to configure?

You can host the bot locally by configuring all necessary values in the config.ini file

• Copy config.ini.sample to a new file config.ini and replace all placeholders with appropriate values
• Copy .env.sample to a new file .env and replace the placeholder with your bot token
• Download a private key file for dialogflow in json format from your google cloud console. To learn more click here
• Rename the downloaded file to dialogflow_api.json and place it in the root directory
• Install all the requirements

$ pip install -r requirements.txt

• Run the bot

$ python main.py

How does it work?

Here's a few example screenshots of how the bot actually works

• Welcome message sent to user on joining

• Welcome card sent to a channel on succesful onboard

• Questions about himself

• Questions about TinkerHub

• Small talk, jokes and uplifitng quotes

• Daily top HackerNews and weekly top rated dev.to articles

• Private message handling and forwarding them to a private channel

What's under the hood?

You can find all the required dependencies in the requirements.txt file. However here's an overview of the major libraries/tools we've used to create Baymax :-

• discordpy
• dialogflow
• google-cloud-dialogflow
• pyairtable
• pillow

Contributing

💡 You can refer to our contributing guide to get started with making contributions

Do you have any thoughts on improving the bot? Ideas, design changes, code cleaning or even major codebase revamps, any and all such contributions are always welcome. Baymax just keeps getting better with each contribution, no matter how big or small 💪. If you'd like to get involved, you can start with the issues listed in our issue tracker or you can create your own issue here.