Purpose
To incorporate aspects of mental well-being into discord usage.
Aspects of social media have become detrimental to mental health, and since many people spend hours a day on Discord, this bot is here to help users improve their mental health as they use Discord. Below is a list of working functionalities as well as install and contributing instructions. Spread kindness, more meaningful days, and emotional support over Discord by contributing!
Functionality
The following functionalities (commands) describe how we are meeting our purpose of this project. They are up and running.
Journal Command: provides random journal-ing prompts for users to answer.
Support Animals Command: provides random images of cute animals
Puzzle Command: provides a puzzle game to challenge your mind!
Diet Reccomendation Command: provides random diet tips
Exercise Command: provides an exercise routine
Help Command: provides a list and description of existing commands
Resources Command: provides Resources, Contacts for Mental Health
Music Command: Provides links for meditation and music to relax.
Install instructions
This project uses discord.js version 14.5.0 and node version 16.17.0.
Please refer to INSTALL.md for more in-depth instructions
Want to Contribute to the project?
Take a look at our documentation
Please read this CONTRIBUTING.md.
View our project roadmap for features to work on.
Contributors
This project has the following contributors:
| Contributor | GitHub ID | |
|---|---|---|
| 1 | Cheerla, Sanjana | Stoir |
| 2 | Ganesh, Saail Gurunath | SaailGanesh |
| 3 | Pardeshi, Sourabh | SourabhPardeshi |
| 4 | Patel, Maya | maya-dc-patel |
| 5 | Xin, Vincent | Culcheese |
Future Roadmap
Click here for our roadmap
The future roadmap has the issues organized showing future possible extensions to this project.
Final Bot Deployment
When the bot is being finally deployed the slash commands must be registerd globally (registerd for every server). Right now (for development purposes), the slash commands are registered per guild mentioned in line 19. To register commands globally during final deployment, edit line 73 in main.js to remove slash commands being registerd for each server.
License
This project is distributed under the Apache License. See LICENSE.txt for more information.
Two Minute Functionality Video
Click for two minute functionality video
Also, see 2MinVideo inside the videos folder.
Click for short 30 second video
Zenodo DOI
Click on the badge below to view the Zenodo DOI page for this project.
[build-url]: https://github.com/orgs/CSC510-G35-Fall2022/projects/1](https://github.com/CSC510-G35-Fall2022/Mental_Health/actions