@imfascinated/bat-framework v0.0.23-DEV

This Package is still under development and not all features are done.

Table of Contents

• Installation
• Setup
• Creating a Command
• Creating a Event
• Guild Data
• Command Permissions
• Command Cooldowns

Installation

NPM

npm install @imfascinated/bat-framework

Setup

After you have installed BatFramework there is a simple setup process.

const Discord = require('discord.js');
const { Client } = require('@imfascinated/bat-framework');
require('dotenv').config()

// Create a discord client instance.
const client = new Discord.Client();
// Initialize Bat-Framework.
const Bot = new Client(client, {
    commandsDirectory: 'Commands',
    eventsDirectory: 'Events',
    featuresDirectory: 'Features',
    showWarns: true,
    autoSaveInterval: 300000, // Guild auto save interval
    forceLoadGuilds: false, // Whether to load all guilds (in the database) on boot
    databaseOptions: {
        keepAlive: true,
        useNewUrlParser: true,
        useUnifiedTopology: true,
        useFindAndModify: false
    },
    botOwners: [
        'owner id', 'another owner'
    ]
});
// Set your Mongo URI path so the framework can use it.
Bot.setMongoPath(process.env.MONGO_URI);
// Set the bots default command prefix, it is ! by default.
Bot.setDefaultPrefix('?');

Bot.on('databaseConnected', () => {
    console.log('Bot » Database connected!');
});

client.login(process.env.TOKEN);

Creating a Command

This is a simple test command to see if the framework is working.

// File name: Test.js
// Folder: /src/Commands (Can also be folders in folders ex: /src/Commands/Info)

const { Message } = require('discord.js');
const { CommandBase } = require('@imfascinated/bat-framework');

module.exports = class TestCommand extends CommandBase {
    constructor() {
        super({
            name: 'test', // Command name
            description: 'This a test command!', // Command description
            aliases: ['testy'], // Command aliases
            botOwnerOnly: true
        });
    }

    /**
     * @param {Message} message 
     * @param {string[]} args 
     */

    async run(message, args) {
        message.channel.send('testy!');
    }
}

Creating a Event

Events can be anything that is called from the DiscordJS Client. Note: The file name can be anything, the "event" option is the event called internally. Example: event: 'ready'

// File name: ready.js
// Folder: /src/Events

const { Client } = require('discord.js');
const { BatClient, EventBase } = require('@imfascinated/bat-framework');

module.exports = class ReadyEvent extends EventBase {
    constructor() {
        super({
            event: 'ready'
        });
    }

    run(instance, client) {
        console.log(`Bot » Ready!`);
    }
}

Guild Data

A simple example of how to update the guilds prefix.

const { CommandBase } = require('@imfascinated/bat-framework');

module.exports = class MessageEvent extends CommandBase {
    constructor() {
        super({
            name: 'setprefix',
            description: 'Simple set prefix command.',
            aliases: ['prefix']
        });
    }

    async run(instance, client, message, args, guildData) {
        if (args.length < 1) {
            // A simple example below on how to retrieve guild data.
            return message.channel.send(`Your prefix: \`${guildData.prefix}\``);
        }
        const prefix = args[0];
        // A simple example below is how to set guild data.

        await guildData.setPrefix(prefix);
        message.channel.send(`Your guilds prefix has been updated to \`${prefix}\`.`);
    }
}

Command Permissions

Permissions required by the user (or client) to use the command.

const { CommandBase } = require('@imfascinated/bat-framework');

module.exports = class MessageEvent extends CommandBase {
    constructor() {
        super({
            name: 'testy',
            description: 'What did you expect to read',
            clientPermissions: [ // The permissions the bot needs to run this command
                'KICK_MEMBERS'
            ],
            userPermissions: [ // The permissions the user needs to run this command
                'ADMINISTRATOR'
            ]
        });
    }

    async run(instance, client, message, args, guildData) {}
}

Command Cooldowns

I don't recommend you use them for cooldowns over 5 mins yet since there is no database integration yet

const { CommandBase } = require('@imfascinated/bat-framework');

module.exports = class MessageEvent extends CommandBase {
    constructor() {
        super({
            name: 'cooldowntest',
            cooldown: 30000 // 30 Seconds
        });
    }

    async run(instance, client, message, args, guildData) {}
}

Features

const { Client } = require('discord.js');
const { BatClient, FeatureBase } = require('@imfascinated/bat-framework');

module.exports = class MessageFeature extends FeatureBase {
    constructor() {
        super();
    }

    /**
     * @param {BatClient} instance 
     * @param {Client} client 
     */

    async init(instance, client) {
        client.on('message', (message) => {
            console.log("msg")
        })
    }
}

Support & Feature Requests

This package is looking for feedback and ideas to help cover more use cases. If you have any ideas feel free to share them with me on discord at https://discord.gg/Q2QKADrk2k