https://github.com/gomezmig03/natalis-bot

Self-hosted discord birthday bot made for github actions.
https://github.com/gomezmig03/natalis-bot

birthday discord discord-bot javascript self-hosted

Last synced: about 1 month ago
JSON representation

Self-hosted discord birthday bot made for github actions.

• Host: GitHub
• URL: https://github.com/gomezmig03/natalis-bot
• Owner: GomezMig03
• License: mpl-2.0
• Created: 2024-10-28T06:41:55.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-09T14:23:47.000Z (about 1 month ago)
• Last Synced: 2024-11-09T15:25:34.555Z (about 1 month ago)
• Topics: birthday, discord, discord-bot, javascript, self-hosted
• Language: JavaScript
• Homepage:
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# Natalis Bot

Natalis Bot is a Discord bot designed to send birthday notifications for members of your server. It’s optimized for deployment via GitHub Actions but can also be hosted elsewhere.

## Features

- Detects and posts birthday notifications on your server.

- Configurable channels and roles for birthday announcements.

- Customizable notification timing through GitHub Actions.

## Deploying the bot

### Prerequisites

1. **Create the Discord Bot:** Head over to the [Discord Developer Portal](https://discord.com/developers) to create your bot, then invite it to your Discord server. Ensure the bot has permissions to:

    - Send messages in the desired channel.

    - Mention the roles for birthday notifications.

2. **Fork the Repository:**

    - Click the "Fork" button on the top-right corner of this repository to get your copy.

3. **Set Up GitHub Actions:**

    - Activate GitHub Actions on your fork.

    - Add your bot token as a GitHub Secret, the name must be DISCORD_TOKEN.

    - (Optional) Adjust the action schedule in the workflow file if you want to customize the time for birthday checks.

### Configuration

1. **Edit config.json:** Customize the bot settings according to your server’s needs.

    - Channels: Add the ID(s) of the channel(s) where you want birthday messages to appear.

    - Roles: Specify the ID(s) of the role(s) to be mentioned in the birthday notifications.

    - Birthdays: List member names and birthdays following the provided format to ensure accurate notifications.

2. **Deploy the Bot:** With GitHub Actions active, the bot will automatically run as per the schedule set in the workflow. If hosting elsewhere, simply deploy according to the platform's guidelines.

## Notes

- For additional customization or troubleshooting, consult the GitHub Actions logs and ensure all permissions are correctly set in Discord.

- If you find a bug, please post an issue in this repo.

- If you want to make your fork private (recommended), download the code and create a new repository instead of using GitHub’s fork feature. This approach allows you to keep your configuration private without affecting the original license.

- Changing only config.json and not index.mjs or other source files does not require you to redistribute your modifications under the MPL 2.0 license.