Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/zaid-maker/jokebot-3


https://github.com/zaid-maker/jokebot-3

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        


  


  

  

  

  

  




# Discord Bot Template



The Discord Bot Template provides a solid foundation for creating feature-rich Discord bots using Discord.js. It includes various managers for handling message commands, buttons, select menus, slash commands, context menus, and modal forms. The template offers customization options, colorful logging, and a simple code structure.



## Changelog



- Latest Discord.js adaptation.

- Refactored command options with significant improvements.

- Updated the code to use camel case throughout the template.

- Renamed all handlers to managers.

- Replaced the slashCommands handler (now manager) with the `Rest.put()` method. Context menus are now managed by the slashCommands manager.

- Introduces a new method for registering global and guild slash commands and context menus. The `guilds: []` property has been removed. Please refer to the guide for the updated registration method.

- Removed the `expireAfter` and `limitUses` command options.

- Reintroduced the `cooldown` command option, divided into `guildCooldown`, `globalCooldown`, and `channelCooldown`. Each option accepts the delay time in milliseconds.



## Documentation



For detailed documentation on command options and managers, please refer to the following links:



### Command Options



- [ReturnErrors](/.github/Docs/CMDOptions/ReturnErrors.md)

- [Ignore](/.github/Docs/CMDOptions/Ignore.md)

- [AllClientPermissions](/.github/Docs/CMDOptions/AllClientPermissions.md)

- [AllowBots](/.github/Docs/CMDOptions/AllowBots.md)

- [AllowInDms](/.github/Docs/CMDOptions/AllowInDms.md)

- [AllUserPermissions](/.github/Docs/CMDOptions/AllUserPermissions.md)

- [AnyClientPermissions](/.github/Docs/CMDOptions/AnyClientPermissions.md)

- [AnyUserPermissions](/.github/Docs/CMDOptions/AnyUserPermissions.md)

- [ChannelCooldown](/.github/Docs/CMDOptions/ChannelCooldown.md)

- [GlobalCooldown](/.github/Docs/CMDOptions/GlobalCooldown.md)

- [GuildCooldown](/.github/Docs/CMDOptions/GuildCooldown.md)

- [OnlyChannels](/.github/Docs/CMDOptions/OnlyChannels.md)

- [OnlyGuilds](/.github/Docs/CMDOptions/OnlyGuilds.md)

- [OnlyRoles](/.github/Docs/CMDOptions/OnlyRoles.md)

- [OnlyUsers](/.github/Docs/CMDOptions/OnlyUsers.md)

- [OwnerOnly](/.github/Docs/CMDOptions/OwnerOnly.md)



### Managers



- [MessageCommands](/.github/Docs/Managers/MessageCommands.md)

- [SelectMenus](/.github/Docs/Managers/SelectMenus.md)

- [Buttons](/.github/Docs/Managers/Buttons.md)

- [Events](/.github/Docs/Managers/Events.md)

- [SlashCommands](/.github/Docs/Managers/SlashCommands.md)

- [ModalForms](/.github/Docs/Managers/ModalForms.md)



## Features



- Colorful and organized logging.

- Customization options to suit your needs.

- Supports management of message commands, buttons, select menus, slash commands, context menus, and modal forms.

- Includes a variety of commonly used command options (not applicable to events).

- Supports management of custom events.

- Simple and understandable code structure.



## Notes



- Recommended Node.js version: 16 and above.

- Global slash commands and context menus may take time to refresh as it is controlled by Discord.

- Guild commands may take time to refresh if there are a large number of different guild commands.

- Collections where command and event data is stored and used:

  - `.messageCommands`: Message commands cache

  - `.messageCommandsAliases`: Message command aliases cache

  - `.events`: Client events cache

  - `.buttonCommands`: Button interactions cache

  - `.selectMenus`: Select menu interactions cache

  - `.modalForms`: Modal form interactions cache

  - `.slashCommands`: Slash commands cache (includes context menus)



## Installation



To get started with the Discord Bot Template, follow these steps:



1. Clone the repository by downloading it as a ZIP file or running the command `git clone https://github.com/rilecraft/discordbot-template`.

2. Navigate to the template's directory and run the command `npm install` (make sure npm is installed).

3. Once all the required modules are installed, open the `Src/Credentials/Config.js` file and fill in the necessary information.

4. Run the command `node bot.js` or `node .` to start the bot.



## Contribution



Contributions to the Discord Bot Template are welcome. To contribute, please follow these guidelines:



1. Fork the `Unstable` branch. **Important: All changes must be made to the Unstable branch.**

2. Make your changes in your forked repository.

3. Open a pull request to the `Unstable` branch, and it will be reviewed promptly.

4. If everything checks out, the pull request will be merged.