Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bluette1/diurnal-help-discord-bot
A Discord bot with various interactive features to enhance your server experience.
https://github.com/bluette1/diurnal-help-discord-bot
Last synced: 10 days ago
JSON representation
A Discord bot with various interactive features to enhance your server experience.
- Host: GitHub
- URL: https://github.com/bluette1/diurnal-help-discord-bot
- Owner: Bluette1
- Created: 2023-12-28T21:40:17.000Z (about 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-08-22T16:11:24.000Z (4 months ago)
- Last Synced: 2024-10-22T07:50:33.911Z (2 months ago)
- Language: JavaScript
- Homepage: https://discord.com/oauth2/authorize?client_id=1261499835228487680
- Size: 634 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# diurnal-help-discord-bot
A Discord bot with various interactive features to enhance your server experience.
[Add diurnal-help on Discord ](https://discord.com/oauth2/authorize?client_id=1261499835228487680)
# Built With
- Nodejs
- [Discordjs](https://discordjs.guide/)
- [Node Cron](https://www.npmjs.com/package/node-cron)
- OpenAI
## Features
- **Welcome Message:** Greets new members when they join the server.
- **Send Me a Quote:** Provides a random inspirational quote on demand.
- **"Buy Me a Coffee" Functionality:** Allows users to support the bot creator with donations.
- **Happy New Year Message:** Automatically sends a celebratory message on New Year's Day.
- **Happy Birthday Message:** Automatically sends a celebratory message on your special day.
- **Task Reminder:** Helps users set and receive reminders for their tasks.
- **ChatGPT Prompt:** Integrates with ChatGPT to answer questions or prompts.
## Getting Started
### Prerequisites
- Node.js
- npm
- Discord account
### Installation
1. Clone the repository:
```bash
git clone https://github.com/Bluette1/diurnal-help-discord-bot.git
cd diurnal-help-discord-bot
```
2. Install dependencies:
```bash
yarn install
```
3. Set up your .env file with your Discord bot token:
```bash
env
TOKEN=your_discord_bot_token
CLIENT_ID=the_discord_client_id
BOT_OWNER_ID=owner_discord_id
OPENAI_API_KEY=your_open_ai_api_key
UPDATE_COMMANDS=0 | 1
BOT_ID=bot_id
```
4. Run the bot:
```bash
yarn start
```
### Usage
Add the bot to your Discord server using the invite link.
Use commands to interact with the bot:
- /ping: responds with "pong"
- sh!list: Checks the current list of reminders.
- sh!addpayment [@your_discord_username] [$Amount]: records a donation made
- sh!stop [task_number]: Stops the given task.
- /quote: User receives an inspirational quote.
- sh!newyear: Checks if today is New Year's Day and sends a message.
- sh!birthday [Month] [Day]: Checks if today is your birthday and sends you a message.
- sh!remind [task] at [24_hr_format_time]: Sets a reminder for a task at given time.
- sh!remind [task] [time_in_x_minutes]: Sets a reminder for a task in x minutes.
- sh!remind repeat [task] [time_in_x_minutes]: Sets a reminder for a task every x minutes.
**Default** (e.g. "Send me a joke"): Interacts with ChatGPT for an AI response.
### Contributing
Contributions are welcome! Please fork the repository and submit a pull request.
### License
This project is licensed under the MIT License.
### Contact
For any questions or feedback, please contact [email protected]
Feel free to customize it further based on your specific implementation and additional details.