Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tfagaming/discordjs-v14-bot-template
A Discord bot with commands, components and events handler based on the latest discord.js v14 and fully written in JavaScript.
https://github.com/tfagaming/discordjs-v14-bot-template
bot-template discord discord-bot discord-bot-template discord-command-handler discord-js discord-js-handler discord-js-handler-v14 discord-js-v14 discord-js-v14-handler discord-v14 discordhandler discordjs discordjs-v14 v14-discord-bot-template
Last synced: about 9 hours ago
JSON representation
A Discord bot with commands, components and events handler based on the latest discord.js v14 and fully written in JavaScript.
- Host: GitHub
- URL: https://github.com/tfagaming/discordjs-v14-bot-template
- Owner: TFAGaming
- License: gpl-3.0
- Created: 2022-07-18T21:17:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-02T21:23:53.000Z (22 days ago)
- Last Synced: 2024-09-24T11:03:18.372Z (about 14 hours ago)
- Topics: bot-template, discord, discord-bot, discord-bot-template, discord-command-handler, discord-js, discord-js-handler, discord-js-handler-v14, discord-js-v14, discord-js-v14-handler, discord-v14, discordhandler, discordjs, discordjs-v14, v14-discord-bot-template
- Language: JavaScript
- Homepage:
- Size: 5.99 MB
- Stars: 345
- Watchers: 5
- Forks: 152
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DiscordJS-V14-Bot-Template v3
A Discord bot commands, components and events handler based on **discord.js v14** and fully written in JavaScript.
Did you like the project? Click on the star button (⭐️) right above your screen, thank you!
## Features
- Updated to the latest version of [discord.js v14.x](https://github.com/discordjs/discord.js/releases).
- Supports all possible type of commands.
- Message commands.
- Application commands:
- Chat Input
- User context
- Message context
- Handles components.
- Buttons
- Select menus
- Modals
- Autocomplete
- Easy and simple to use.
- Advanced command options.
- Simple Database included (YAML).
## Commands, Components, and Events structure:
### Message commands:
[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype).
`Awaitable` means the function might be **async**.
```ts
new MessageCommand({
command: {
name: string, // The command name
description?: string, // The command description (optional)
aliases?: string[], // The command aliases (optional)
permissions?: PermissionResolvable[], // The command permissions (optional)
},
options?: Partial<{
cooldown: number, // The command cooldown, in milliseconds
botOwner: boolean, // Bot owner can only run it? (true = yes, false = no)
guildOwner: boolean, // Guild owner can only run it? (true = yes, false = no)
botDevelopers: boolean, // Bot developers can only run it? (true = yes, false = no)
nsfw: boolean // The command contains NSFW content? (true = yes, false = no)
}>,
run: Awaitable<(client: DiscordBot, message: Message, args: string[]) => void> // The main function to execute the command
});
```
### Application commands (Chat input, User context, Message context):
[`APIApplicationCommand`](https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-structure), [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype).
`Awaitable` means the function might be **async**.
```ts
new ApplicationCommand({
command: APIApplicationCommand,
options?: Partial<{
cooldown: number, // The command cooldown, in milliseconds
botOwner: boolean, // Bot owner can only run it? (true = yes, false = no)
guildOwner: boolean, // Guild owner can only run it? (true = yes, false = no)
botDevelopers: boolean, // Bot developers can only run it? (true = yes, false = no)
}>,
run: Awaitable<(client: DiscordBot, interaction: Interaction) => void> // The main function to execute the command
});
```
### Components:
#### Autocomplete:
`Awaitable` means the function might be **async**.
```ts
new AutocompleteComponent({
commandName: string,
run: Awaitable<(client: DiscordBot, interaction: AutocompleteInteraction) => void> // The main function to execute the command
});
```
#### Buttons, Select Menus, and Modals:
[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype).
`Awaitable` means the function might be **async**.
```ts
new Component({
customId: string,
type: 'modal' | 'select' | 'button',
options?: Partial<{
public: boolean // Other users can use the main interaction author button/select? (true = yes, false = no)
}>
run: Awaitable<(client: DiscordBot, interaction: Interaction) => void> // The main function to execute the command
});
```
### Events:
`Awaitable` means the function might be **async**.
`K` is a type parameter, extends `keyof ClientEvents`.
```ts
new Event({
event: K,
once?: boolean, // The event can only happen once? (true = yes, false = no)
run: Awaitable<(client: DiscordBot, ...args: ClientEvents[K]) => void>
});
```
## Dependencies
- **colors** → latest
- **discord.js** → 14.13.0 or newer
- **dotenv** → latest
- **quick-yaml.db** → latest
> [!NOTE]
> **Node.js v16.11.0** or newer is required to run **discord.js**.
## Setup
1. Install a code editor ([Visual Studio Code](https://code.visualstudio.com/Download) for an example).
2. Download this project as a **.zip** file: [Download](https://github.com/TFAGaming/DiscordJS-V14-Bot-Template/archive/refs/heads/main.zip)
3. Extract the **.zip** file into a normal folder.
4. Open your code editor, click on **Open Folder**, and select the new created folder.
5. Rename the following files:
- `src/example.config.js` → `src/config.js`: Used for handler configuration.
- `.env.example` → `.env`: Used for secrets, like the Discord bot token.
- `example.database.yml` → `database.yml`: Used as a main file for the database.
- `example.terminal.log` → `terminal.log`: Used as a clone of terminal (to save previous terminal messages).
6. Fill all the required values in **config.js** and **.env**.
> [!CAUTION]
> Please remember not to share your Discord bot token! This will give access to attackers to do anything they want with your bot, so please keep the token in a safe place, which is the **.env** file.
7. Initialize a new project: `npm init` (To skip every step, do `npm init -y`).
8. Install all [required dependencies](#dependencies): `npm install colors discord.js dotenv quick-yaml.db`
9. Run the command `node .` or `npm run start` to start the bot.
10. Enjoy! The bot should be online.
## Contributing
Feel free to fork the repository and submit a new pull request if you wish to contribute to this project.
Before you submit a pull request, ensure you tested it and have no issues. Also, keep the same coding style, which means don't use many unnecessary spaces or tabs.
Thank you to all the people who contributed to **DiscordJS-V14-Bot-Template**!
## Support
Join our Discord server if you have any questions to ask, or if you have a problem with this project, you can go to the [issues section](https://github.com/TFAGaming/DiscordJS-V14-Bot-Template/issues) and submit a new issue.
## License
[**GPL-3.0**](./LICENSE), General Public License v3