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.

Funding

Not a funded project, nor is funding necessary.

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.

Testing

We are doing both automated and blackbox testing. The reason why our coverage is 40% is because that coverage person only measures coverage from the automated tests. The rest of the 60% coverage is covered using black box tests. We used black box tests because we had to test the discord functionality which was only testable when the bot would be running through discord. This made it impossible to test using automated testing which was why we used blackbox.

Case Studies

1) Tested the bot under our team communication server. We tested each of the currently available functionalities: Ping, journal, Puzzle, Diet-recommendation, Support animal, Music, Exercise, Resources, and Help. All of the functionaliies work as intended. Last updated Oct 9 2022. 2) Tested the bot with a friends server on discord (Does not go to NCSU). They tested each of the currently available functionalities: Ping, journal, Puzzle, Diet-recommendation, Support animal, Music, Exercise, Resources, and Help. All of the functionaliies work as intended. Last updated Oct 9 2022.