advanced-cmd
v1.6.2
Published
Una npm que sirve para hacer un comando de prefix y interacción en el mismo archivo
Downloads
29
Readme
Configuración
Debe poner el siguiente comando en su terminal:
npm i -g advanced-cmd-cli
Después de eso, vuelva a abrir la terminal y ponga el siguiente comando en el directorio donde creara el bot:
advanced-cmd-cli <nameCarpet>
<nameCarpet>
hace referencia a el nombre de la carpeta del bot
Este es el metodo más fácil para crear un bot utilizando advanced-cmd
También lo puede adaptar, para eso lea la documentación que está más abajo
Soporte
Correo: [email protected]
Este proyecto funciona en Typescript
también además de Javascript
Cualquier bug reportarlo por el servidor de soporte en un ticket
Si quieres adaptar advanced-cmd
a tu proyecto lee la documentación que está abajo
CommandBuilder
setName()
setDescription()
setExecute()
addStringOption()
addUserOption()
addRoleOption()
addChannelOption()
addAttachmentOption()
addIntegerOption()
addBooleanOption()
isolate()
verify()
toJSON()
MessageMenuBuilder
Este es lo mismo que CommandBuilder
solo que es para hacer los menú en los mensajes con el paquete y solo tiene los métodos setName()
, setExecute()
y toJSON()
que sirven para lo mismo que en CommandBuilder y su forma de utilizar es igual
ContextMenuBuilder
Este es lo mismo que CommandBuilder
solo que es para hacer los menú en los usuarios con el paquete y solo tiene los métodos setName()
, setExecute()
y toJSON()
que sirven para lo mismo que en CommandBuilder y su forma de utilizar es igual
Otras funciones
config()
reload()
Documentación
Métodos
.setName(string)
<CommandBuilder>.setName()
es un método que permite establecer el nombre en tu comando
Este es totalmente obligatorio para un comando, si no el paquete no funcionara
Ejemplo:
const { CommandBuilder } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.setName("ping")
.setDescription(string)
<CommandBuilder>.setDescription()
es un método que permite establecer la descripción de tu comando
Este también es totalmente obligatorio para un comando, si no el paquete no funcionara
Ejemplo:
const { CommandBuilder } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.setDescription("Ve mi ping en ws")
.setExecute(Function)
<CommandBuilder>.setExecute()
es un método que permite establecer que hará el comando, este también es obligatorio en un comando de lo contrario el paquete no funcionara
Dentro del .setExecute()
va una función que tiene dos parametros client
y interaction
client es equivalente a Client de discord.js
interaction es equivalente a CommandInteraction de discord.js
, este tiene unos pequeños añadidos como que existe el valor interaction.isMsg
para saber si es un mensaje o una interacción debido a que hay valores que solo están en un tipo de comando, otro añadido es que se puede usar tanto interaction.user
como interaction.author
Ejemplo:
const { CommandBuilder } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.setExecute(
function (client, interaction){
interaction.reply(`Mi ping es de **${client.ws.ping}ms**`)//Sirve tanto para mensaje como para interacción
}
)
Si se tiene alguna duda sobre los métodos, pronto se publicara en el paquete los métodos que se pueden utilizar, por ahora puedes ir al Servidor de Discord y abrir un ticket si tienes alguna duda
.addStringOption(options)
<CommandBuilder>.addStringOption()
es un método que permite agregar una opción de tipo STRING
en tu comando
Ejemplo:
const { CommandBuilder } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.addStringOption({ nombre: "texto", desc: "El texto" })
Hay dos opciones que no son obligatorias required
y joined
joined
sirve para que agarre todo el contenido restante del mensaje: No se recomienda utilizar porque el paquete hace esto de manera automática si la ultima opcion es STRING
(proximamente podrá configurar este aspecto)
required
sirve para establecer si la opción es necesaria o no
.addUserOption(options)
<CommandBuilder>.addUserOption()
es un método que permite agregar una opción de tipo USER
en tu comando
Ejemplo:
const { CommandBuilder } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.addUserOption({ nombre: "usuario", desc: "El usuario" })
La única opción no obligatoria es required
que sirve para establecer si la opción es requerida o no
.addRoleOption(options)
<CommandBuilder>.addRoleOption()
es un método que permite agregar una opción de tipo ROLE
en tu comando
Ejemplo:
const { CommandBuilder } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.addRoleOption({ nombre: "rol", desc: "El rol" })
La única opción no obligatoria es required
que sirve para establecer si la opción es requerida o no
.addChannelOption(options)
<CommandBuilder>.addChannelOption()
es un método que permite agregar una opción de tipo CHANNEL
en tu comando
Ejemplo:
const { CommandBuilder } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.addChannelOption({ nombre: "canal", desc: "El canal" })
La única opción no obligatoria es required
que sirve para establecer si la opción es requerida o no
.addAttachmentOption(options)
<CommandBuilder>.addAttachmentOption()
es un método que permite agregar una opción de tipo ATTACHMENT
en tu comando
Tenga en cuenta que si solo hay una opción en el comando al hacer un getAttachment()
devolvera el primer archivo que hay, de lo contrario el paquete va a agarrar el número del index de la opción (creando un array solo para las opciones ATTACHMENT) y devolvera el que sea según ese número
Un ejemplo es que si el número de index es 1 (en el Array de solo ATTACHMENT) va a devolver el segundo archivo
En este caso no use el required ya que todavía esta en beta (solo funcionara en el tipo de comando interacción), mejor haga esto:
const { CommandBuilder } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.setName("archivo")
comando.setDescription("Un archivo")
comando.addAttachmentOption({ nombre: "file", desc: "el archivo" })
comando.setExecute(
function (client, interaction){
const option = interaction.options.getAttachment("file")
if(!option){
interaction.reply("Este comando necesita un archivo")
return;
}
}
)
Ejemplo:
const { CommandBuilder } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.addAttachmentOption({ nombre: "file", desc: "el archivo" })
required
es una opción no obligatoria pero está en beta (solo funcionara en interacción) así que no la utilize
.addIntegerOption(options)
<CommandBuilder>.addIntegerOption()
es un método que permite agregar una opción de tipo INTEGER
en su comando
Esto significa que el número que se debe introducir debe ser entero
Ejemplo:
const { CommandBuilder } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.addIntegerOption({ nombre: "entero", desc: "El entero" })
La única opción no obligatoria es required
que sirve para establecer si la opción es requerida o no
Pronto, método addNumberOption()
para cualquier tipo de número
.addBooleanOption(options)
<CommandBuilder>.addBooleanOption()
es un método que permite agregar una opción de tipo BOOLEAN
en su comando
Esto significa que el valor que se debe introducir es true
o false
(tanto en mensaje como interacción)
Ejemplo:
const { CommandBuilder } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.addBooleanOption({ nombre: "boolean", desc: "El boolean" })
La única opción no obligatoria es required
que sirve para establecer si la opción es requerida o no
.isolate(CommandType)
<CommandBuilder>.isolate()
es un método que permite limitar el comando a solo un tipo
Esto significa que hará que el comando solo se ejecute en interacción o en mensaje
Ejemplo:
const { CommandBuilder, CommandType } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.isolate(CommandType.Message)
CommandType.Message
hace referencia al comando de mensaje
CommandType.Interaction
hace referencia al comando de interacción
.verify()
<CommandBuilder>.verify()
es un método que permite verificar algunas cosas en el comando
Ejemplo:
const { CommandBuilder } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.verify()
.toJSON()
<CommandBuilder>.toJSON()
es un método que devuelve los datos del comando que hace el paquete para la interacción y mensaje
Ejemplo:
const { CommandBuilder } = require("advanced-cmd")
const comando = new CommandBuilder()
comando.toJSON()
Funciones extra
config(options)
config()
es un método que permite configurar el paquete
Opciones (obligatorias):
client
: Es el cliente de discord.js
directory
: Cómo se llama el directorio donde están los comandos (es importante decir que el handler es por subcarpetas)
__dirname
: En este parametro se pone __dirname
y ya, sirve para decir cuál es la ruta del archivo actual
prefix
: El prefijo de tu bot
Ejemplo:
const { Client } = require("discord.js")
const client = new Client({ intents: 3276799 })
client.login("TOKEN")
const { config } = require("advanced-cmd")
config(client, "Comandos", __dirname, "!")
reload(client)
reload()
es un método que sirve para recargar los comandos
Opciones:
client
: El cliente de discord.js
Ejemplo:
const { Client } = require("discord.js")
const client = new Client({ intents: 3276799 })
client.login("TOKEN")
const { config, reload } = require("advanced-cmd")
config(client, "Comandos", __dirname, "!")
client.on("ready", () => {
console.log("Bot listo")
reload(client)
})