├── .gitignore ├── .env.example ├── .gitattributes ├── models └── user.js ├── structures ├── EventClass.js ├── Functions.js ├── CommandClass.js └── Client.js ├── index.js ├── events ├── guild │ └── interactionCreate.js └── client │ └── ready.js ├── package.json ├── handlers ├── Event.js └── Command.js ├── commands └── general │ └── test.js ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .env 2 | /node_modules -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | TOKEN= 2 | GUILD_ID= 3 | MONGO_URI= -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /models/user.js: -------------------------------------------------------------------------------- 1 | const Mongoose = require("mongoose"); 2 | 3 | // Example of a schema for a user. 4 | const UserSchema = new Mongoose.Schema({ 5 | _id: { 6 | type: String, 7 | }, 8 | }); 9 | 10 | module.exports = Mongoose.model("User", UserSchema); 11 | -------------------------------------------------------------------------------- /structures/EventClass.js: -------------------------------------------------------------------------------- 1 | // Do not touch this unless you know what you are doing. 2 | 3 | module.exports = class Event { 4 | constructor(client, options = {}) { 5 | this.client = client; 6 | this.name = options.name; 7 | } 8 | 9 | async run() { 10 | throw new Error(`The Event "${this.name}" does not provide a run method.`); 11 | } 12 | }; 13 | -------------------------------------------------------------------------------- /structures/Functions.js: -------------------------------------------------------------------------------- 1 | /* 2 | Use this file to store functions that you want to use in multiple files in your bot. 3 | Example of a function that checks if an interaction exists. 4 | */ 5 | 6 | module.exports = { 7 | interactionExists: async (client, message) => { 8 | const channel = client.channels.cache.get(message.channel.id); 9 | try { 10 | await channel.messages.fetch(message.id); 11 | return true; 12 | } catch (err) { 13 | return false; 14 | } 15 | }, 16 | }; 17 | -------------------------------------------------------------------------------- /structures/CommandClass.js: -------------------------------------------------------------------------------- 1 | // Do not touch this unless you know what you are doing. 2 | 3 | module.exports = class Command { 4 | constructor(client, meta = {}) { 5 | this.client = client; 6 | this.name = meta.name; 7 | this.type = meta.type; 8 | this.options = meta.options || []; 9 | this.isModal = meta.isModal || false; 10 | this.category = meta.category || null; 11 | this.description = meta.description || null; 12 | } 13 | 14 | async run() { 15 | throw new Error( 16 | `The Slash Command "${this.name}" does not provide a run method.` 17 | ); 18 | } 19 | }; 20 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | /* 2 | Name: index.js 3 | Path: / 4 | Description: This is the main file of the bot. It is the entry point of the bot. 5 | Author: carvethedegen 6 | Version: 1.0.0 7 | License: Apache-2.0 8 | 9 | Instructions: 10 | 1. Install the required packages with npm install. 11 | 2. Create a .env file in the root directory of the bot. 12 | 3. Add the following to the .env file: 13 | TOKEN=YOUR_BOT_TOKEN 14 | GUILD_ID=YOUR_GUILD_ID 15 | MONGO_URI=YOUR_MONGO_URI 16 | 4. Run the bot with node index.js 17 | */ 18 | 19 | require("dotenv").config(); 20 | 21 | const Client = require("./structures/Client"); 22 | 23 | const client = new Client(); 24 | 25 | client.login(); 26 | -------------------------------------------------------------------------------- /events/guild/interactionCreate.js: -------------------------------------------------------------------------------- 1 | const Discord = require("discord.js"); 2 | const Event = require("../../structures/EventClass"); 3 | 4 | module.exports = class InteractionCreate extends Event { 5 | constructor(client) { 6 | super(client, { 7 | name: "interactionCreate", 8 | }); 9 | } 10 | async run(interaction) { 11 | if (interaction.type === Discord.InteractionType.ApplicationCommand) { 12 | const command = this.client.commands.get(interaction.commandName); 13 | 14 | if (!command) return; 15 | 16 | try { 17 | if (!command.isModal) { 18 | await interaction.deferReply(); 19 | } 20 | command.run(this.client, interaction); 21 | } catch (e) { 22 | console.log(e); 23 | } 24 | } 25 | } 26 | }; 27 | -------------------------------------------------------------------------------- /structures/Client.js: -------------------------------------------------------------------------------- 1 | // This is the main client file for the bot. 2 | 3 | const Discord = require("discord.js"); 4 | const EventHandler = require("../handlers/Event"); 5 | const Mongoose = require("mongoose"); 6 | 7 | module.exports = class BotClient extends Discord.Client { 8 | constructor(...opt) { 9 | super({ 10 | opt, 11 | intents: 131071, 12 | }); 13 | 14 | this.events = new Discord.Collection(); 15 | this.commands = new Discord.Collection(); 16 | new EventHandler(this).build("../events"); 17 | } 18 | 19 | async login() { 20 | // Connect to MongoDB 21 | // If you don't want to use MongoDB, remove this or comment it out. 22 | await Mongoose.connect(process.env.MONGO_URI) 23 | .then(() => console.log("MongoDB Connected.")) 24 | .catch((err) => console.log(err)); 25 | 26 | await super.login(process.env.TOKEN); 27 | } 28 | }; 29 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "djs-14-framework", 3 | "version": "1.0.0", 4 | "description": "A framework to build discord bots on the most recent DJS version.", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "npm run test" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/carvethedegen/djs-14-framework.git" 12 | }, 13 | "keywords": [ 14 | "discordbot", 15 | "discord", 16 | "djs", 17 | "framework" 18 | ], 19 | "author": "carvethedegen", 20 | "license": "Apache-2.0", 21 | "bugs": { 22 | "url": "https://github.com/carvethedegen/djs-14-framework/issues" 23 | }, 24 | "homepage": "https://github.com/carvethedegen/djs-14-framework#readme", 25 | "dependencies": { 26 | "discord.js": "^14.7.1", 27 | "dotenv": "^16.0.3", 28 | "fs": "^0.0.1-security", 29 | "mongoose": "^6.10.0", 30 | "path": "^0.12.7" 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /handlers/Event.js: -------------------------------------------------------------------------------- 1 | // This is the event handler, it will load all the events in the events folder. 2 | 3 | const fs = require("fs"); 4 | const path = require("path"); 5 | const BaseEvent = require("../structures/EventClass"); 6 | 7 | module.exports = class EventClass { 8 | constructor(client) { 9 | this.client = client; 10 | } 11 | 12 | async build(dir) { 13 | const filePath = path.join(__dirname, dir); 14 | const files = await fs.promises.readdir(filePath); 15 | for (const file of files) { 16 | const stat = await fs.promises.lstat(path.join(filePath, file)); 17 | if (stat.isDirectory()) this.build(path.join(dir, file)); 18 | if (file.endsWith(".js")) { 19 | const Event = require(path.join(filePath, file)); 20 | if (Event.prototype instanceof BaseEvent) { 21 | const event = new Event(this.client); 22 | this.client.events.set(event.name, event); 23 | this.client.on(event.name, event.run.bind(event)); 24 | } 25 | } 26 | } 27 | } 28 | }; 29 | -------------------------------------------------------------------------------- /commands/general/test.js: -------------------------------------------------------------------------------- 1 | // This is a command that has subcommands. 2 | 3 | const Discord = require("discord.js"); 4 | const Command = require("../../structures/CommandClass"); 5 | 6 | module.exports = class Test extends Command { 7 | constructor(client) { 8 | super(client, { 9 | name: "test", 10 | isModal: false, 11 | category: "General", 12 | type: Discord.ApplicationCommandType.ChatInput, 13 | description: "Test command.", 14 | options: [ 15 | { 16 | name: "meow", 17 | description: "meow command.", 18 | type: Discord.ApplicationCommandOptionType.Subcommand, 19 | }, 20 | { 21 | name: "bark", 22 | description: "woof command", 23 | type: Discord.ApplicationCommandOptionType.Subcommand, 24 | }, 25 | ], 26 | }); 27 | } 28 | 29 | async run(client, interaction) { 30 | if (interaction.options.getSubcommand() === "meow") { 31 | interaction.editReply("Meow..."); 32 | } else if (interaction.options.getSubcommand() === "bark") { 33 | interaction.editReply("Woof!"); 34 | } 35 | } 36 | }; 37 | -------------------------------------------------------------------------------- /events/client/ready.js: -------------------------------------------------------------------------------- 1 | // This is the file called when the bot logs in with the token from your .env file. 2 | 3 | const Event = require("../../structures/EventClass"); 4 | const CommandHandler = require("../../handlers/Command"); 5 | const { ActivityType } = require("discord.js"); 6 | 7 | module.exports = class ReadyEvent extends Event { 8 | constructor(client) { 9 | super(client, { 10 | name: "ready", 11 | }); 12 | } 13 | 14 | async run() { 15 | // This is the code that loads all the slash commands. 16 | const guild = this.client.guilds.cache.get(process.env.GUILD_ID); 17 | await guild.members.fetch(); 18 | await new CommandHandler(this.client) 19 | .build("../commands") 20 | .then(() => console.log("Slash commands loaded.")); 21 | console.log(`${this.client.user.tag} is online.`); 22 | 23 | // Set the bot's presence. 24 | // You can change the status and activity type. 25 | this.client.user.setPresence({ 26 | activities: [ 27 | { 28 | name: `For your commands...`, 29 | type: ActivityType.Watching, 30 | }, 31 | ], 32 | status: "dnd", 33 | }); 34 | } 35 | }; 36 | -------------------------------------------------------------------------------- /handlers/Command.js: -------------------------------------------------------------------------------- 1 | // This is the command handler for slash commands (interactions), it will load all the commands in the commands folder. 2 | 3 | const fs = require("fs"); 4 | const path = require("path"); 5 | const BaseCommand = require("../structures/CommandClass"); 6 | 7 | module.exports = class CommandClass { 8 | constructor(client) { 9 | this.client = client; 10 | } 11 | 12 | async build(dir) { 13 | try { 14 | const filePath = path.join(__dirname, dir); 15 | const files = await fs.promises.readdir(filePath); 16 | for (const file of files) { 17 | const stat = await fs.promises.lstat(path.join(filePath, file)); 18 | if (stat.isDirectory()) this.build(path.join(dir, file)); 19 | if (file.endsWith(".js")) { 20 | const Command = require(path.join(filePath, file)); 21 | if (Command.prototype instanceof BaseCommand) { 22 | const cmd = new Command(this.client); 23 | await this.client.commands.set(cmd.name, cmd); 24 | await this.client.guilds.cache 25 | .get(process.env.GUILD_ID) 26 | .commands.create(cmd); 27 | } 28 | } 29 | } 30 | } catch (e) { 31 | console.log(e); 32 | } 33 | } 34 | }; 35 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 |
4 |
5 | 6 |

Discord JS v14 Framework

7 | 8 |

9 | A Discord.JS v14 framework that allows you to create advanced discord bots without having to create everything from scratch. 10 |

11 |
12 | 13 | 14 | 15 | ## Getting Started 16 | 17 | Getting started is very straight forward, just follow the instructions below. 18 | 19 | ### Prerequisites 20 | 21 | This is an example of how to list things you need to use the software and how to install them. 22 | 23 | - npm 24 | ```sh 25 | npm install 26 | ``` 27 | 28 | ### Installation 29 | 30 | _Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._ 31 | 32 | 1. Create a .env file. 33 | 2. Add the following variables and fill them out. 34 | ```sh 35 | TOKEN= 36 | GUILD_ID= 37 | MONGO_URI= 38 | ``` 39 | 3. Run the bot from the main directoy using 40 | ```sh 41 | node index.js 42 | ``` 43 | 44 | 45 | 46 | ## Contributing 47 | 48 | Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. 49 | 50 | If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". 51 | Don't forget to give the project a star! Thanks again! 52 | 53 | 1. Fork the Project 54 | 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 55 | 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 56 | 4. Push to the Branch (`git push origin feature/AmazingFeature`) 57 | 5. Open a Pull Request 58 | 59 | 60 | 61 | ## License 62 | 63 | Distributed under the Apache-2.0 License. See `LICENSE.txt` for more information. 64 | 65 | 66 | 67 | ## Contact 68 | 69 | Carve aka Felon - [@carvethedegen](https://twitter.com/carvethedegen) 70 | 71 | Project Link: [https://github.com/carvethedegen/djs-14-framework](https://github.com/carvethedegen/djs-14-framework) 72 | 73 |

(back to top)

74 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------