chore: scaffold community server discord bot

apps/discord-bot/.gitignore

@@ -0,0 +1,4 @@
+dist/
+node_modules/
+cooldownDB.sqlite
+tsconfig.tsbuildinfo

apps/discord-bot/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 RileCraft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

apps/discord-bot/README.md

@@ -0,0 +1,116 @@
+<p align="center">
+  <img src="https://media.discordapp.net/attachments/774290264764055582/1093484780525469757/A_banner_for_a_discord_bots_template_made_using_discord.js.png" height="200" width="400"><br>
+  <img src="https://img.shields.io/badge/version-1.0.7-05122A?style=for-the-badge">
+  <a href="https://discord.gg/VStdRr8nP2"><img src="https://img.shields.io/badge/discord-invite-5865f2?style=for-the-badge&logo=discord&logoColor=white"></a>
+  <img src="https://img.shields.io/github/issues/RileCraft/DiscordBot-Template-ts.svg?style=for-the-badge">
+  <img src="https://img.shields.io/github/forks/RileCraft/DiscordBot-Template-ts.svg?style=for-the-badge">
+  <img src="https://img.shields.io/github/stars/RileCraft/DiscordBot-Template-ts.svg?style=for-the-badge">
+</p>
+
+# Discord Bot Template TS
+
+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
+
+### IMPORTANT UPDATE 1.0.7
+
+- **Fixed Windows Support and SlashCommands & ContextMenus not Registering.**
+- Added dependency of `simple-json-db` for the cooldown system as i rage quit and can't do it with `fs` myself.
+- Fixed subDirectories not working for commands.
+- Latest Discord.js adaptation.
+- Following JavaScript Naming Convention.
+- Removed `node-recursive-directory` dependency.
+- Support for `AutoCompleteInteraction` added.
+- Converted from `CommonJS` to `ESM Module`.
+- Improved handling of all events, commands with lower memory usage.
+- Main file `bot.ts` has been shifted to `src`.
+- Config file has been shifted to `Src`.
+- Moved from `Collections` to `Map`.
+- `messageCommandsAliases` has been renamed to `messageCommands_Aliases`
+- `Quick.DB` has been removed and instead all cooldowns data will be now stored in `CooldownDB.txt` in the root directory using `fs`.
+- Refactored command options.
+- `chalk` has been replaced with `tasai`.
+- Extended all command options support to interactions.
+- All custom types and interfaces are exported from `./src/types.ts`.
+- `SlashCommands` and `ContextMenus` has been seperated into different folders and managed differently.
+- `SlashCommands` have been simplified as now instead of `Guilds/<GuildID>/<Files Here>`, you can use `guilds: ["GUILD ID"]`
+- In a slashCommand you do not need to assign the `type: ApplicationCommandType` property as the handler by default assumes it as `ChatInput`.
+
+## Documentation
+
+For detailed documentation on command options and managers, please refer to the following links:
+
+### Command Options
+
+- [ReturnErrors](/.github/DOCS/commandOptions/returnErrors.md)
+- [Ignore](/.github/DOCS/commandOptions/ignore.md)
+- [AllClientPermissions](/.github/DOCS/commandOptions/allClientPermissions.md)
+- [AllowBots](/.github/DOCS/commandOptions/allowBots.md)
+- [AllowInDms](/.github/DOCS/commandOptions/allowInDms.md)
+- [AllUserPermissions](/.github/DOCS/commandOptions/allUserPermissions.md)
+- [AnyClientPermissions](/.github/DOCS/commandOptions/anyClientPermissions.md)
+- [AnyUserPermissions](/.github/DOCS/commandOptions/anyUserPermissions.md)
+- [ChannelCooldown](/.github/DOCS/commandOptions/channelCooldown.md)
+- [GlobalCooldown](/.github/DOCS/commandOptions/globalCooldown.md)
+- [GuildCooldown](/.github/DOCS/commandOptions/guildCooldown.md)
+- [OnlyChannels](/.github/DOCS/commandOptions/onlyChannels.md)
+- [OnlyGuilds](/.github/DOCS/commandOptions/onlyGuilds.md)
+- [OnlyRoles](/.github/DOCS/commandOptions/onlyRoles.md)
+- [OnlyUsers](/.github/DOCS/commandOptions/onlyUsers.md)
+- [OwnerOnly](/.github/DOCS/commandOptions/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)
+- [ContextMenus](/.github/DOCS/managers/contextMenus.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:
+  - `<Client>.messageCommands`: Message commands cache
+  - `<Client>.messageCommands_Aliases`: Message command aliases cache
+  - `<Client>.events`: Client events cache
+  - `<Client>.buttonCommands`: Button interactions cache
+  - `<Client>.selectMenus`: Select menu interactions cache
+  - `<Client>.modalForms`: Modal form interactions cache
+  - `<Client>.slashCommands`: Slash commands cache
+  - `<Client>.contextMenus`: ContextMenus commands cache
+
+## 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-ts`.
+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/config.ts` file and fill in the necessary information.
+4. Run the command `npm run build && npm run start` to start the bot.
+
+You can also use `npm run dev` to run the application in development mode, which will refresh the application after any
+changes. If the interaction elements loading logs are excessive, set `LOG_READY_EXPLICIT` to `false` in `src/config.ts`.
+
+## 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.

apps/discord-bot/nodemon.json

@@ -0,0 +1,5 @@
+{
+  "watch": ["src"],
+  "ext": "ts",
+  "exec": "tsc --incremental && node dist/bot.js"
+}

apps/discord-bot/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "discord-bot",
+  "type": "module",
+  "description": "",
+  "license": "",
+  "main": "./src/bot.ts",
+  "scripts": {
+    "build": "tsc && echo 'Finishing Building'",
+    "dev": "nodemon",
+    "start": "node ./dist/bot.js"
+  },
+  "dependencies": {
+    "discord.js": "^14.14.1",
+    "ms": "^2.1.3",
+    "simple-json-db": "^2.0.0",
+    "tasai": "^1.0.0",
+    "undici-types": "^5.26.5"
+  },
+  "devDependencies": {
+    "@types/ms": "^0.7.34",
+    "@types/node": "^20.11.5",
+    "nodemon": "^3.1.7",
+    "typescript": "^5.3.3"
+  }
+}

apps/discord-bot/src/bot.ts

@@ -0,0 +1,53 @@
+import type { DiscordClient } from 'discord.js'
+import type { ButtonCommand, ClientEvent, ContextMenu, MessageCommand, ModalForm, SelectMenu, SlashCommand } from './types.js'
+import { dirname } from 'node:path'
+import { Client, GatewayIntentBits, Partials } from 'discord.js'
+import JSONdb from 'simple-json-db'
+import { BOT_TOKEN } from './config.js'
+import { ButtonManager } from './structures/managers/buttonCommands.js'
+import { EventManager } from './structures/managers/events.js'
+import { MessageCMDManager } from './structures/managers/messageCommands.js'
+import { ModalManager } from './structures/managers/modalForms.js'
+import { SelectMenuManager } from './structures/managers/selectMenus.js'
+import { SlashManager } from './structures/managers/slashCommands.js'
+
+const __dirname: string = dirname(import.meta.url)
+export const rootPath = __dirname;
+
+(async (): Promise<void> => {
+  const client: DiscordClient = new Client({
+    intents: [
+      GatewayIntentBits.Guilds,
+      GatewayIntentBits.GuildMessages,
+      GatewayIntentBits.GuildPresences,
+      GatewayIntentBits.DirectMessages,
+      GatewayIntentBits.MessageContent, // Only for bots with message content intent access.
+      GatewayIntentBits.DirectMessageReactions,
+      GatewayIntentBits.GuildMembers,
+      GatewayIntentBits.GuildMessageReactions,
+      GatewayIntentBits.GuildWebhooks,
+      GatewayIntentBits.GuildVoiceStates,
+      GatewayIntentBits.GuildInvites,
+    ],
+    partials: [Partials.Channel],
+  })
+
+  client.cooldownDB = new JSONdb('./cooldownDB.json')
+
+  client.messageCommands = new Map<string, MessageCommand>()
+  client.messageCommands_Aliases = new Map<string, string>()
+  client.events = new Map<string, ClientEvent>()
+  client.buttonCommands = new Map<string, ButtonCommand>()
+  client.selectMenus = new Map<string, SelectMenu>()
+  client.modalForms = new Map<string, ModalForm>()
+  client.contextMenus = new Map<string, ContextMenu>()
+  client.slashCommands = new Map<string, SlashCommand>()
+
+  await MessageCMDManager(client, __dirname)
+  await EventManager(client, __dirname)
+  await ButtonManager(client, __dirname)
+  await SelectMenuManager(client, __dirname)
+  await ModalManager(client, __dirname)
+  await client.login(BOT_TOKEN)
+  await SlashManager(client, __dirname) // Includes context menu handling as they belong to same command type.
+})()

apps/discord-bot/src/config.ts

@@ -0,0 +1,5 @@
+export const LOG_READY_EXPLICIT = true // Set to 'false' to reduce terminal spam for development server
+
+export const PREFIX: Array<string> = ['Bot Prefix']
+export const BOT_TOKEN: string = 'Bot Token'
+export const OWNER_IDS: Array<string> = ['Bot Owner Discord ID']

apps/discord-bot/src/events/errorManager.ts

@@ -0,0 +1,15 @@
+import type { ClientEvent } from '../types.js'
+// import process from 'node:process'
+
+export const Event: ClientEvent = {
+  name: 'errorManager',
+  customEvent: true,
+  run: (): void => {
+    // process.on('unhandledRejection', (error: Error) => {
+    //   console.log(error)
+    // })
+    // process.on('uncaughtException', (error: Error) => {
+    //   console.log(error)
+    // })
+  },
+} // Error Handler to avoid the bot from crashing on error.

apps/discord-bot/src/events/interactionCreate.ts

@@ -0,0 +1,68 @@
+import type { DiscordClient, Interaction } from 'discord.js'
+import type { ButtonCommand, ClientEvent, ContextMenu, ModalForm, SelectMenu, SlashCommand } from '../types.js'
+import commandOptionsChecker from '../structures/commandOptions/processor.js'
+
+export const Event: ClientEvent = {
+  name: 'interactionCreate',
+  run: async (interaction: Interaction<'cached'>, client: DiscordClient): Promise<void> => {
+    if (interaction.isChatInputCommand()) {
+      const slashCommand: SlashCommand | undefined = client.slashCommands?.get(interaction.commandName)
+      if (!slashCommand)
+        return
+
+      if (!await commandOptionsChecker(client, interaction, slashCommand, 'SlashCommand'))
+        return
+      else slashCommand.run(interaction, client)
+    }
+
+    else if (interaction.isAutocomplete()) {
+      const slashCommand: SlashCommand | undefined = client.slashCommands?.get(interaction.commandName)
+      if (!slashCommand || !slashCommand.autocomplete)
+        return
+
+      if (!await commandOptionsChecker(client, interaction, slashCommand, 'SlashCommand'))
+        return
+      else slashCommand.autocomplete(interaction, client)
+    }
+
+    else if (interaction.isContextMenuCommand()) {
+      const contextMenu: ContextMenu | undefined = client.contextMenus?.get(interaction.commandName)
+      if (!contextMenu)
+        return
+
+      if (!await commandOptionsChecker(client, interaction, contextMenu, 'ContextMenu'))
+        return
+      else contextMenu.run(interaction, client)
+    }
+
+    else if (interaction.isAnySelectMenu()) {
+      const selectMenuCommand: SelectMenu | undefined = client.selectMenus?.get(interaction.values[0]) ?? client.selectMenus?.get(interaction.customId)
+      if (!selectMenuCommand)
+        return
+
+      if (!await commandOptionsChecker(client, interaction, selectMenuCommand, 'SelectMenu'))
+        return
+      else selectMenuCommand.run(interaction, client)
+    }
+
+    else if (interaction.isButton()) {
+      const buttonInteraction: ButtonCommand | undefined = client.buttonCommands?.get(interaction.customId)
+      if (!buttonInteraction)
+        return
+
+      if (!await commandOptionsChecker(client, interaction, buttonInteraction, 'Button'))
+        return
+      else buttonInteraction.run(interaction, client)
+    }
+
+    else if (interaction.isModalSubmit()) {
+      const modalInteraction: ModalForm | undefined = client.modalForms?.get(interaction.customId)
+      if (!modalInteraction)
+        return
+
+      if (!await commandOptionsChecker(client, interaction, modalInteraction, 'ModalForm'))
+        return
+      else modalInteraction.run(interaction, client)
+    };
+  },
+} // InteractionCreate event to handle all interactions and execute them.

apps/discord-bot/src/events/messageCreate.ts

@@ -0,0 +1,30 @@
+import type { DiscordClient, Message } from 'discord.js'
+import type { ClientEvent, MessageCommand } from '../types.js'
+import { PREFIX } from '../config.js'
+import commandOptionsChecker from '../structures/commandOptions/processor.js'
+
+export const Event: ClientEvent = {
+  name: 'messageCreate',
+  run: (message: Message, client: DiscordClient): void => {
+    if (!Array.isArray(PREFIX))
+      return
+    PREFIX.forEach(async (botPrefix: string) => {
+      if (!message.content.startsWith(botPrefix))
+        return
+      const commandName: string = message.content.toLowerCase().slice(botPrefix.length).trim().split(' ')[0]
+      const command: MessageCommand | undefined = client.messageCommands?.get(commandName) ?? client.messageCommands?.get(client.messageCommands_Aliases?.get(commandName) ?? '')
+      if (!command)
+        return
+      const args: Array<string> = message.content.slice(botPrefix.length).trim().slice(commandName.length).trim().split(' ')
+      const processedCommandOptionsChecker: boolean = await commandOptionsChecker(client, message, command, 'MessageCommand')
+
+      if (!command.allowInDms && !message.guild)
+        return
+      if (!command.allowBots && message.author.bot)
+        return
+
+      if (processedCommandOptionsChecker)
+        await command.run(client, message, args)
+    })
+  },
+} // MessageCreate event to handle all messages and execute messageCommands (if found).