Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gyginee/discord_resource

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/gyginee/discord_resource
Owner: Gyginee
License: gpl-3.0
Created: 2023-10-25T04:01:38.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-10-30T21:35:06.000Z (over 1 year ago)
Last Synced: 2024-11-09T08:21:43.887Z (3 months ago)
Language: JavaScript
Size: 41 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# DiscordJS-V14-Bot-Template v2

The simplified and popular Discord bot commands & events handler built with discord.js version 14 and written in JavaScript. This handler can load up to 4 different type of commands; Prefix, Slash, User context and Message context. It can also handles components; Buttons, Modal submits, Select menus (any type).

Did you like my project? Click on the star button (⭐️) right above your screen, thank you!

Looking for the old version? [Click here](https://github.com/TFAGaming/DiscordJS-V14-Bot-Template/releases/tag/v1.7.0-last).

## Features
- Supports all possible type of commands.
- Message commands (AKA: Prefix commands).
- Application commands:
- Chat Input
- User context
- Message context
- Components Handler.
- Buttons
- Select menus
- Modals
- Easy and simple to use.
- Advanced command options ([click here](#command-options)).
- Updated to latest discord.js version.
- Included a database: MongoDB.

## Commands, events, and components structure

> **Note**
> This handler uses **CommonJS** modules system.

### Prefix:
```ts
module.exports = {
structure: {
name: string,
description: string,
aliases: string[],
permissions?: PermissionFlagsBits | string,
cooldown?: number,
developers?: boolean,
nsfw?: boolean
},
run: async (client, message, args) => Promise
};
```

### Slash/User/Message:
```ts
module.exports = {
structure: SlashCommandBuilder | ContextMenuCommandBuilder,
options?: {
cooldown?: number,
developers?: boolean,
nsfw?: boolean
},
run: async (client, interaction) => Promise
};
```

### Event:
```ts
module.exports = {
event: string,
once?: boolean,
// '...args' are the arguments of the event chosen (from discord.js).
run: async (client, ...args) => Promise
};
```

### Component:
```ts
module.exports = {
customId: string,
// 'interaction' is the interaction of the component. If the custom ID is from a button, the interaction is type of ButtonInteraction.
run: async (client, interaction) => Promise
};
```

## Requirements
### Packages:
- **chalk** v2.4.2
- **discord.js** v^14.13.0
- **dotenv** v^latest
- **mongoose** v^latest

> **Warning**
> Installing any version from the package `chalk` that is over **v2.4.2**, it will throw an error that you must enable ES6 modules, while this handler uses CommonJS modules.

### Platforms:
- **Node.js** v16.9.0 or newer

## Setup
1. Install Visual Studio Code.
2. Download this project as a **.zip** file: [Click here](https://github.com/TFAGaming/DiscordJS-V14-Bot-Template/archive/refs/heads/main.zip)
3. Extract the .zip file into a normal folder.
4. Open VSCode, click on **Open Folder**, and select the new created folder.
5. Go to `src/` and rename `example.config.js` to `config.js` and fill all the required values.

```ts
module.exports = {
client: {
token: string, // ← Your bot token (USE .env IS RECOMMENDED)
id: string // ← Your bot ID (USE .env IS RECOMMENDED)
},
handler: {
prefix: string, // ← The bot prefix
deploy: boolean, // ← Always load application commands to Discord? (true: Yes, false: No)
commands: {
prefix: boolean, // ← Toggle prefix commands
slash: boolean, // ← Toggle slash commands
user: boolean, // ← Toggle user commands
message: boolean // ← Toggle message commands
},
mongodb: {
uri: string, // ← Your MongoDB URI string (USE .env IS RECOMMENDED)
toggle: boolean // ← Connect to the database or not? (true: Yes, false: No)
}
}
}
```

You can use ENV instead of `config.js` to keep your bot token and ID and your MongoDB URI in a safe place. Rename the file `.env.example` to `.env` and fill all the required values.

```apache
CLIENT_TOKEN = Your bot token
CLIENT_ID = Your bot ID
MONGODB_URI = Your mongodb URI string
```

6. Initialize a new package and install all [required packages](#packages):

```
npm init -y
npm install [email protected] discord.js dotenv mongoose
```

7. To start your bot, run `node .` or `npm run start`.
8. Enjoy. =)

## Hosting ()
Use [Discloud](https://discloudbot.com/)! A trust-worthy Discord bot hosting service.

1. Login using your Discord/GitHub account, and then don't close the Dashboard tab (because we need it later).
2. Go to your project on VSCode, create a new file `discloud.config`. This file is a configuration file for Discloud apps servers. The `discloud.config` file content must be like the codeblock below, and remember to change **YOUR_BOT_ID** to your actual bot ID.

```apache
ID = YOUR_BOT_ID
TYPE = bot
MAIN = src/index.js
RAM = 100
AUTORESTART = true
VERSION = latest
API = tools
```

3. Open explorer and navigate using the path of your project. Hold the **CTRL** key, and click on `src/`, `package.json`, and `discloud.config`. Now release the key, and right click on the selected files/folders and click on **Convert into .zip file**.
4. Go back to the Discloud dashboard, click on **Add App**, and then upload the .zip file in the upload box. Make sure to accept the ToS of the service and then click on **Upload**.
5. Wait for at least 20 seconds (depends on your Internet speed), and then your bot should be on.

> **Warning**
> Discloud has recently made every Free plan servers into **15 days** hosting only. Use the command `.rw` from their bot in the commands channel (on their Discord server) to reset the timer. Join the server: [Click here!](https://discord.gg/discloud-584490943034425391)

## Command options
The command options, each property is optional, which means it's allowed to provide an `undefined` value to one of these properties below.

- `permissions` (**PermissionFlagsBits** | **string**): The required permissions for the command, available to message commands only.
- `cooldown` (**number**): The cooldown of the command, in milliseconds.
- `developers` (**boolean**): Whenever the command is executable only to the developers of the bot.
- `nsfw` (**boolean**): Whenever this command is executable only in NSFW channels.

## Contributors
Thank you to all the people who contributed to **DiscordJS-V14-Bot-Template**!

## Support
Join our Discord server if you need any help!

## FAQs
### I'm getting this error: "Unable to load application commands to Discord API"
This error only hapens if your bot token and bot ID are not from the same bot. For an example, if you get a bot token from a bot, and a bot ID from another bot, this will throw the error. If you get the token and the ID from the same bot, it will return no errors.

### Is MongoDB required?
No, MongoDB is not required. There is an option to disable it in `config.js` so you will avoid errors from the commands that requires the database, such as `?prefix`. If you want to use the database, [visit MongoDB website](https://www.mongodb.com/).

## License
[**GPL-3.0**](./LICENSE), General Public License v3