diamond-handler
Advanced tools
Readme
DiamondHandler is a discord.js handler
npm i diamond-handler
📂src
┣ 📂cmds - commands dir
┃ ┗ 📂utils - category dir
┃ ┃ ┣ 📜!category.json - category info
┃ ┃ ┗ 📜test.cmd.js - command
┣ 📂features - features dir
┃ ┗ 📜test.feature.js - feature
┣ 📜index.js - main file
┗ 📜Messages.json - JSON file for messages
const DiamondHandler = require('diamond-handler');
const { Client } = require('discord.js');
const client = new Client({
intents: [], //Your intents
});
const handler = new DiamondHandler(client, {
commandsDir: 'cmds', //Where command files are stored
featuresDir: 'features', //Where features files are stored
messagesPath: 'messages.json', //Where messages are stored
});
client.login('superSecretToken');
module.exports = {
name: 'test', //The name of the command
description: 'Test command', //The description of the command (you can also specify the description for different languages in Messages.json)
run: (interaction, args) => {
//Function parameters: 1 - interaction 2 - arguments 3- instance (DiamondHandler)
interaction.reply('Hello world!');
},
};
module.exports = (client, instance) => {
//Function parameters 1 - client 2 - instance (DiamondHandler)
console.log('Hello world!');
};
nameThe name of the command
descriptionThe description of the command
disabledSould the command be disabled or not
permissionsThe permissions that the user must have to execute the command. If user doesn't have any of given permissions he will not be able to execute the command. If he has any of the given permissions he will be able to execute the command.
Type: Array of FLAGS or our permissions
botPermissionsThe permissions that the bot must have to execute the command.
Type: Array of FLAGS
optionsCommand arguments
nameThe name of the option
descriptionThe description of the option
typeThe type of the option (see option types)
run(interaction, args, instance)Function that will be run when command is executed
interactionargsArguments provided by user
instanceDiamondHandler instance
module.exports = {
name: 'name',
description: 'description',
options: [
{
name: 'test',
description: 'test subcommand',
type: 'sub_command',
},
{
name: 'test2',
description: 'test subcommand 2',
type: 'sub_command',
},
],
run: (interaction, args, instance) => {
console.log(args.subcommand); //'test' or 'test2'
//args.subcommand returns which subcommand was run
},
};
These are all options you can pass to the handler as second argument
commandsDirDirectory where commands are stored
featuresDirDirectory where features are stored
messagesPathFile where messages are stored
fileEndingsIf file in commandsDir or featuresDir not ends with this this file will be ignored
commandsFile endings in commandsDir. Default: .cmd.js
featuresFile endings in featuresDir. Default: .feature.js
defaultLanguageDefault language used in message system. Default: english
setColor(color)Sets the default color in embed
colorThe color to set
setGuildLanguage(guildId, language)Sets guild language (used in message system)
guildIdID of the guild to be set on
languageLanguage to set
setGuildPermissions(guildId, permissions)Sets guild permissions (used in permission system)
guildIdID of the guild to set on
permissionsPermissions to set
setGlobalPermissions(permissions)Similar to setGuildPermissions but sets global permissions (permissions which work for every guild)
getMessage(path, placeholders)See message system
getLanguage()Returns the guild language
getMessage(path, placeholders)Returns the message from Messages.json based on guild language
pathThe path in messages object e.g. test.testMessage
{{
"internal": {
"commandsLoaded": "Loaded {size} commands",
"featuresLoaded": "Loaded {size} features"
},
"external": {
"english": {
"test": {
"testMessage": "Hello world!"
}
}
}
}}
placeholdersObject with placeholders
{
testPlaceholder: 'Test'
}
If message contains placeholder (in this example {testPlaceholder}) it will be replaced with the value of placeholder (in this example Test)
hasPerms(nodes)Check if the member of interaction has following permissions.
nodesArray of permissions (read more about our permission system here)
getMessage(path, placeholders)See message system
embed (data)Creates MessageEmbed with default color
dataMessageEmbed or MessageEmbedData
errorEmbed (message, data)Creates errorEmbed with given message
messageThe message to set into embed
dataMessageEmbed or MessageEmbedData
flagsToText (flags)Returns translated FLAGS based on guild language
flagsThe flags to translate
createPages (pages, options)Creates paginator
pagesThe array of pages to create paginator from
optionsafkTimeoutTime of inactivity to auto close paginator. Default: 2 minutes
endMessageMessage to display after paginator is closed. False will leave current page. Default: false
Our permission system is simple. You provide an array of groups, and each group contains a list of members and permissions.
Example group:
{
name: 'the name of group',
members: ['Discord user ID or Discord role ID'],
permissions: ['permission']
}
Basic usage is simple. For example permission commands.utils.ban gives group access to use function, where was provided permission commands.utils.ban
What are they? Wildcard is char (in this handler *)that gives all permissions from parent node. For example permission commands.utils.* gives permissions for all functions whose parent node is commands.utils
Negation is a char (in this handler -)that removes permission from group. For example group has permissions commands.utils.* and -commands.utils.kick. This group can run all functions whose parent node is commands.utils but cannot run command.utils.kick
Group members are simply an array of Discord User IDs or Discord Role IDs
Our message system is based on the Messages file. Example file:
{
"internal": {
"commandsLoaded": "Loaded {size} commands",
"featuresLoaded": "Loaded {size} features"
},
"external": {
"english": {
"slashCommandsLoadAddingError": "Cannot add slash commands to this server, bot must be added with the `application.commands` scope",
"errorEmbedTitle": "Error",
"permissions": {
"CREATE_INSTANT_INVITE": "CREATE INSTANT INVITE",
"KICK_MEMBERS": "KICK MEMBERS",
"BAN_MEMBERS": "BAN MEMBERS",
"ADMINISTRATOR": "ADMINISTRATOR",
"MANAGE_CHANNELS": "MANAGE CHANNELS",
"MANAGE_GUILDS": "MANAGE GUILDS",
"ADD_REACTIONS": "ADD REACTIONS",
"VIEW_AUDIT_LOGS": "VIEW AUDIT LOGS",
"PRIORITY_SPEAKER": "PRIORITY SPEAKER",
"STREAM": "STREAM",
"VIEW_CHANNEL": "VIEW CHANNEL",
"SEND_MESSAGES": "SEND MESSAGES",
"SEND_TTS_MESSAGES": "SEND TTS MESSAGES",
"MANAGE_MESSAGES": "MANAGE MESSAGES",
"EMBED_LINKS": "EMBED LINKS",
"ATTACH_FILES": "ATTACH FILES",
"READ_MESSAGE_HISTORY": "READ MESSAGE HISTORY",
"MENTION_EVERYONE": "MENTION EVERYONE",
"USE_EXTERNAL_EMOJIS": "USE EXTERNAL EMOJIS",
"VIEW_GUILD_INSHIGHTS": "VIEW GUILD INSHIGHTS",
"CONNECT": "CONNECT",
"SPEAK": "SPEAK",
"MUTE_MEMBERS": "MUTE MEMBERS",
"DEAFEN_MEMBERS": "DEAFEN MEMBERS",
"MOVE_MEMBERS": "MOVE MEMBERS",
"USE_VAD": "USE VAD",
"CHANGE_NICKNAMES": "CHANGE NICKNAMES",
"MANAGE_NICKNAMES": "MANAGE NICKNAMES",
"MANAGE_ROLES": "MANAGE ROLES",
"MANAGE_WEBHOOKS": "MANAGE WEBHOOKS",
"MANAGE_EMOJIS_AND_STICKERS": "MANAGE EMOJIS AND STICKERS",
"USE_APPLICATION_COMMANDS": "USE APPLICATION COMMANDS",
"REQUEST_TO_SPEAK": "REQUEST TO SPEAK",
"MMANAGE_THREADS": "MANAGE THREADS",
"USE_PUBLIC_THREADS": "USE PUBLIC THREADS",
"USE_EXTERNAL_STICKERS": "USE EXTERNAL STICKERS"
},
"errors": {
"noPermissions": "You don't have required permissions to perform this action. Required permissions: {permissions}",
"noBotPermissions": "Bot does not have required permissions to perform this action. Required permissions: {permissions}",
"commandDisabled": "Sorry. This command was disabled by developers",
"paginatorNoPermissions": "You can't use the paginator if it isn't your"
},
"internalError": {
"title": "Bot error",
"description": "An error occurred while executing this command"
},
"commands": {
"test": {
"description": "Test command",
"messages": {
"test": "ok"
}
}
}
}
}
}
Internal messages are messages, that will be displayed in the console. You can get internal message by <instance>.getMessage
External messages are messages, that will be displayed in the guild, so they are divided into different languages. You can get external message based on language by <guild>.getMessage
Command messages are a part of external messages. You can use it to specify command description and command options description. Example:
"commands": {
"test": {
"description": "Test command",
"messages": {
"test": "ok"
}
}
}
Messages in command object are simply messages, that can you get with <interaction>.getMessage
{
"internal": {
"test": "Hello {testPlaceholder}"
}
}
<instance>.getMessage("test", {
testPlaceholder: "World!"
})
If message contains placeholder (in this example {testPlaceholder}) it will be replaced with the value of placeholder (in this example World!)
FAQs
Discord.js handler
The npm package diamond-handler receives a total of 4 weekly downloads. As such, diamond-handler popularity was classified as not popular.
We found that diamond-handler demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.