Package Exports
- commandkit
- commandkit/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (commandkit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
CommandKit
CommandKit is a library that makes it easy to handle commands (+ validations), and events in your Discord.js projects.
Supports Discord.js version 14
Features
- Very beginner friendly 🚀
- Support for slash and context menu commands ✅
- Automatic command registration, edits, and deletion 🤖
- Supports multiple development servers 🤝
- Supports multiple users as bot developers 👥
- Object oriented 💻
Documentation
You can find the full documentation here
Installation
To install CommandKit, simply run the following command:
For npm:
npm install commandkitFor yarn:
yarn add commandkitUsage
This is a simple overview of how to set up this library with all the options. You can read more in the full documentation
// index.js
const { Client, GatewayIntentBits } = require('discord.js');
const { CommandKit } = require('commandkit');
const path = require('path');
const client = new Client({
intents: [
GatewayIntentBits.Guilds,
GatewayIntentBits.GuildMessages,
GatewayIntentBits.MessageContent,
],
});
new CommandKit({
// Your discord.js client object
client,
// Path to the commands folder
commandsPath: path.join(__dirname, 'commands'),
// Path to the events folder
eventsPath: path.join(__dirname, 'events'),
// Path to the validations folder (only valid if "commandsPath" was provided)
validationsPath: path.join(__dirname, 'validations'),
// Array of development server IDs (used to register and run devOnly commands)
devGuildIds: ['DEV_SERVER_ID_1', 'DEV_SERVER_ID_2'],
// Array of developer user IDs (used for devOnly commands)
devUserIds: ['DEV_USER_ID_1', 'DEV_USER_ID_2'],
// Array of developer role IDs (used for devOnly commands)
devRoleIds: ['DEV_ROLE_ID_1', 'DEV_ROLE_ID_2'],
// A property that disables CommandKit's built-in validations
skipBuiltInValidations: true,
});
client.login('YOUR_TOKEN_HERE');