diff --git a/README.md b/README.md index 37ded23..86df1c2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

Welcome to NamVr Discord Bot Template 👋

- Version + Version Documentation @@ -21,6 +21,8 @@ `NamVr` Discord Bot Template is an open source discord.js based bot template to get started on a new bot project. It is classic javascript template, not requiring any external dependencies unlike other famous frameworks. (This is not a framework!) You can scale any kind of bot project using this template. (single server based or multiple server based) It all depends on your creativity! +> 🛠️ **NEW!** _This template now supports **in-built typing (typescript-assistance) support** too, which means you will get all typescript-like assistant in vanilla javascipt! (Visual Studio Code tested, working 100% as expected)_ + ### Features: This template comes in with many in-built useful and flexible features, such as @@ -42,13 +44,13 @@ This template comes in with many in-built useful and flexible features, such as - Trigger Handler also has the same skeleton structure as of command handler. The trigger handler is associated with the [triggers](https://github.com/NamVr/DiscordBot-Template/tree/master/triggers/) folder. There are trigger categories, like [reactions](https://github.com/NamVr/DiscordBot-Template/tree/master/triggers/reactions) folder, in the trigger folder. - A sample trigger command is given in the [`hello.js`](https://github.com/NamVr/DiscordBot-Template/tree/master/triggers/reactions/hello.js) trigger file. -#### • **[NEW] Dynamic Slash Command Handler:** +#### • **Dynamic Slash Command Handler:** - My template comes with a dynamic slash command handler with very easy to customize and make slash commands. - The commands, in the slashCommands folder, receive an [`CommandInteraction`](https://discord.js.org/#/docs/main/stable/class/CommandInteraction) object. You can see the [documentation of discord.js](https://discord.js.org/#/docs/main/stable/class/CommandInteraction) for all the properties and methods available. - **IMPORTANT:** In the template, we are sending the slash commands to discord to be registered only to 1 guild. That is because their are 2 types of slash commands, guild and global. Guild commands are restricted to 1 guild but whenever you update them, they take effect immediately, whereas global commands take upto 1 hour to take effect. So use guild commands in development and global commands for production. -#### • **[NEW] Dynamic Buttons Interaction Handler:** +#### • **Dynamic Buttons Interaction Handler:** - This template comes with a dynamic button interaction handler to receive and process button interactions. - Buttons can be classified in two category folders. @@ -58,7 +60,7 @@ This template comes in with many in-built useful and flexible features, such as - Easily handle incoming modal submittions using the template handler! - Modals can be categorized in different folders. -#### • **[NEW] Dynamic Context Menu Handler:** +#### • **Dynamic Context Menu Handler:** - All new addition to discord API is context menus! You can right click a user or message -> Apps to find these options! - This template will register all your context menu options and dynamically interact with them! Worth a try. @@ -81,10 +83,10 @@ npm install - Rename [`config-example.json`](https://github.com/NamVr/DiscordBot-Template/blob/master/config-example.json) to `config.json` and fill the token and other values. Extend config.json according to your needs! -## Run tests +## Run your bot ```sh -npm run test +npm start ``` ## Support & Documentation