JSPM

commandkit

0.0.7
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2912
  • Score
    100M100P100Q113904F
  • License MIT

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.

Tested with Discord.js version v14.11.0

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

npm

To install CommandKit, simply run the following command:

For npm:

npm install commandkit

For yarn:

yarn add commandkit

Usage

This is a simple overview of how to set up this library with all the options.

It's highly recommended you check out the documentation to fully understand how to work with this library.

// index.js
const { Client, IntentsBitField } = require('discord.js');
const { CommandKit } = require('commandkit');
const path = require('path');

const client = new Client({
  intents: [IntentsBitField.Flags.Guilds],
});

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'],
});

client.login('YOUR_TOKEN_HERE');