https://github.com/yamdbf/command-usage

YAMDBF plugin for logging command usage and command usage statistics
https://github.com/yamdbf/command-usage

Last synced: about 1 month ago
JSON representation

YAMDBF plugin for logging command usage and command usage statistics

• Host: GitHub
• URL: https://github.com/yamdbf/command-usage
• Owner: yamdbf
• Created: 2017-07-21T22:34:49.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T07:02:27.000Z (about 2 years ago)
• Last Synced: 2024-11-20T13:29:32.527Z (about 1 month ago)
• Language: TypeScript
• Size: 677 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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:

```js

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:

```js

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.