yamdbf / command-usage

YAMDBF plugin for logging command usage and command usage statistics

command-usage

command-usage is a plugin for Discord bots that are written with YAMDBF+Discord.js that gives the ability to have commands logged to a specified channel and to view command usage statistics via a usagestats command.

Usage

Install the package via npm:

npm install --save @yamdbf/command-usage

or to install the indev version:

npm install --save @yamdbf/command-usage@indev

Note: This plugin depends on YAMDBF >3.0.0, so obviously make sure yamdbf is installed

There are two ways to use the plugin after installing. The first is a simple automatic import by passing 'command-usage' to your YAMDBF Client options plugins array field:

const { Client } = require('@yamdbf/core');

const client = new Client({
	...
	plugins: ['command-usage']
});

Using the plugin this way does not allow for command logging to Discord

The second is via a manual import, which will give access to command logging via a specified guild text channel. You must import commandUsage from the package and pass it to your YAMDBF Client options plugins array field with the channel ID of the channel you want commands to be logged to:

const { Client } = require('@yamdbf/core');
const { commandUsage } = require('@yamdbf/command-usage');

const client = new Client({
	...
	plugins: [commandUsage('channelID')]
});

If you find any problems or have any suggestions, don't hesitate to open up an issue.