# with npm
npm install djs-marshal --save
# with yarn
yarn add djs-marshal
# this package also requires discord.js
npm install discord.js --save
In your root file, preferably index.js/ts, initialize the bot like so
-import Marshal from 'djs-marshal'
import { Intents } from "discord.js";
import path from 'path';
// https://deathvenom54.github.io/djs-marshal/modules.html#initializeBot
const client = Marshal.initializeBot({
intents: [Intents.FLAGS.GUILDS],
// you can pass in the token to make the client login
// automatically
token: 'your-token-here',
// this is the folder path that contains your commands
slashCommandsPath: path.join(__dirname, 'commands'),
// send all log messages
logLevel: 'verbose',
// logs messages in a detailed manner
logStyle: 'expanded'
});
+You can set up your bot to handle commands in 2 ways:
+
+
+ initializeBot()
+
+This is the recommended way to set up your bot. It sets up various things
+like commands' directory, logging and handlers for various events required.
+import Marshal from 'djs-marshal';
import path from 'path';
const client = Marshal.initializeBot({
// the path where slash commands are stored
slashCommandsPath: path.join(__dirname, 'commands'),
// (optional) message to log on ready event
readyMessage: 'Logged in as {tag}',
// (optional) bot's token, will login if provided
token: process.env.BOT_TOKEN,
// (default: 'warn') the level of logs to log in the console
logLevel: 'verbose',
// (default: 'simple') how to style the logs
logStyle: 'extended',
});
// if you didn't provide the token above, log in yourself
// client.login(process.env.BOT_TOKEN);
+
+
+ Doing it yourself
+
+I don't recommend this, but if you want to, by all means you can set it up yourself.
+import Marshal from './src/index';
import Discord from 'discord.js';
import path from 'path';
const client = new Discord.Client();
// load commands
Marshal.loadCommandsFromDir(path.join(__dirame, 'commands'));
// some parameters
client.logLevel = 'warn';
client.logStyle = 'simple';
// handlers
client.on('interactionCreate', Marshal.handlers.handleInteraction);
client.on('guildAdd', Marshal.handlers.handleGuildJoin);
// add this only if you have a command with allowWithPermission
client.on('guildMemberUpdate', Marshal.handlers.handleGuildMemberUpdate);
client.login(process.env.BOT_TOKEN);
+
+
+
+ Commands
+
Now in your commands' folder, you can start creating command files!
Here are some examples:
// ping.js|ts
import { SlashCommand } from "djs-marshal";
// a pretty basic command. command is a discord.js
// CommandInteraction and you can use its methods like
// reply, defer, editReply, etc.
const ping: SlashCommand = {
name: 'ping',
description: 'Play ping-pong with me',
commandType: 'global',
execute (command) {
command.reply('Pong!')
}
};
export default ping;
// https://deathvenom54.github.io/djs-marshal/modules.html#SlashCommand
@@ -37,4 +54,4 @@ Quick Start
Contributing
Please read CONTRIBUTING.md for the guidelines to contribute to this project.
-Generated using TypeDoc