Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lrmn7/welcy
A Discord bot that sends a welcome/farewell message and an image with the background and profile picture of a user who joins the server
https://github.com/lrmn7/welcy
discord-bot discord-farewell discord-welcome
Last synced: about 2 months ago
JSON representation
A Discord bot that sends a welcome/farewell message and an image with the background and profile picture of a user who joins the server
- Host: GitHub
- URL: https://github.com/lrmn7/welcy
- Owner: lrmn7
- License: mit
- Created: 2023-07-23T15:37:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-08T09:54:22.000Z (over 1 year ago)
- Last Synced: 2024-05-01T22:38:05.071Z (8 months ago)
- Topics: discord-bot, discord-farewell, discord-welcome
- Language: JavaScript
- Homepage:
- Size: 600 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Discord Welcome Bot
A Discord bot that sends a welcome message and an image with the background and profile picture of a user who joins the server. Built using NodeJS, runs on nodemon
## Features
- Sends a welcome message and image for new members
- Slash command to check the bot's ping and information
## Installation
1. Clone this repository.
```
git clone https://github.com/lrmn7/welcy.git
```
2. Install the required dependencies
```
npm install
```
3. Configure the bot by adding your bot token and other necessary details to the `config.js` file.
4. Run the bot using
```
node index.js
```
or by using nodemon
```
nodemon index.js
```
## Usage
Once the bot is running and connected to your server, it will automatically send a welcome message and image whenever a new member joins the server. Additionally, you can use the following slash command:
- `/ping`: Check the bot's ping and information.
## Configuration
To configure the bot, you need to provide the following details in the `config.js` file :
- `YOUR_BOT_TOKEN`: Replace with your actual bot token.
- `YOUR_CLIENT_ID`: Replace with your bot's client ID.
- `YOUR_GUILD_ID`: Replace with the ID of the guild (server) where you want to register the slash commands.
- `WELLCOME_CHANNEL_ID`: Replace with the actual channel ID for the welcome message.
- `FAREWELL_CHANNEL_ID`: Replace with the actual channel ID for the farewell message.
Rest of the configurations can be done according to your wish in the `config.js` file.
## Dependencies
- discord.js: `^14.11.0`
- @discordjs/rest: `^1.z.1`
- discord-api-types: `^9.0.0`
- canvafy: `^7.0.4`
- nodemon: `^3.0.1`
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.