@flor01/discordjs-framework v1.0.9

Framework

This module makes making bot way easier! The module loads the commands and events without a command handler needed! The bot also activates the commands when executed.

Installing the bot

1. Install module: npm install --save @flor01/discordjs-framework
2. Make index.js with code:

const module = require("@flor01/discordjs-framework");

new module({
    token: "TOKEN", // Bot token
    language: "NL", // NL/EN
    prefix: "!", // prefix => !help, !rank, ..
})

This works too:

const module = require("@flor01/discordjs-framework");

new module("TOKEN")

3. Make commands folder with command file

• Command template:

module.exports = {
    name: 'example',
    category: '',
    aliases: ['ex'],
    description: 'This is an example command',
    run: async (bot, message, args) => {
        message.reply("hey")
    }
}

4. Make an events folder with an event

• Event layout:

module.exports.name = 'ready';
module.exports.run = async (client) => {
    console.log("I am online!");
}

Options

new module({
    token: "TOKEN",                     // REQUIRED. Bot token
    language: "EN",                     // Language: NL/EN
    prefix: "!",                        // prefix: !help, !rank, ..
    config: {
        guildSettings: { prefix: "!" }, // Standard settings when bot joins a new guild
        userSettings: {},               // Standard settings when a new user uses the bot
    },
    igbots: true,                       // Ignore messages from bots
    status: "everyone",                 // Bot stauts
    statusType: "PLAYING"               // Bot status type
})

Using custom functions

Command test.js (in commands folder)

Send embed with standard footer, embed color and timestamp

message.sendEmbed({title: "Hello", desc: "Hey!"});

Sends the same embed as before, but you can edit this one!

let embed = message.embed()
    .setTitle("Hello")
    .setDescription("Hey!")
message.channel.send(embed);

Send an automatic error message

if(!args[0]) return message.error("You didn't give args!");

Send an automatic succes message

if(args[0]) message.succes("You did give args, good job!");

Find a member

        let member = message.getMember(args[0]);
        if(!member) return message.error("Can't find this member!");

Find a channel

        let channel = message.getChannel(args[0]);
        if(!channel) return message.error("Can't find this channel!");

Find a role

        let role = message.getRole(args[0]);
        if(!role) return message.error("Can't find this role!");

Check if a user is staff

        if(!message.member.isStaff()) return message.error("You aren't staff!"); // Same with isMod and isAdmin

Using the database

The bot loads a database automatically. There are 2 different kinds:

User database

if(!message.author.settings.xp) message.author.settings.xp = 0;
message.author.settings.xp + 5;
message.author.updateDB(); // Update the user settings
message.succes(`You have gained 5 XP! You now have ${message.author.settings.xp} xp!`)

Guild database

let prefix = message.guild.settings.prefix
message.guild.settings.prefix = "?";
message.guild.updateDB(); // Update the guild settings

The db itself

let data = client.db.get("test"); // Get the data of value "test"
client.db.set("test", "hello"); // Set the value "test" to "hello"
client.db.delete("test"); // Delete the data of value "test"