A powerful and flexible library for modularizing Discord.js clients.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs Update guide.md Jun 22, 2018
src Linting. Jun 22, 2018
test Rework CommandParser to always trim prefix. Feb 17, 2018
.babelrc Don't need this. Oct 23, 2017
.esdoc.json Folder naming. Oct 23, 2017
.eslintrc.json Service rework. Apr 1, 2017
.gitignore Update .gitignore. Mar 31, 2017
.travis.yml Travis. Mar 31, 2017
CHANGELOG.md Changelog. Feb 17, 2018
LICENSE Initial commit Jul 23, 2016
README.md Switch back to ESDoc hosting. Feb 17, 2018
command.js Fix exports. Apr 1, 2017
middleware.js Fix exports. Apr 1, 2017
package.json v0.5.0 Jun 22, 2018
yarn.lock Updates. Jun 22, 2018

README.md

Ghastly

npm build docs license

Introduction

Ghastly is a modular command library built for Discord.js bots. It provides a powerful but flexible API which abstracts away boilerplate and makes command building a more elegant process.

Installation

Ghastly is available through npm.

npm install --save ghastly

or

yarn add ghastly

You should also install Discord.js v11 if you haven't already. This library requires Node.js >=7. For Node.js <7.6, you must start your application using node --harmony in order to enable support for async functions.

Example

This is a short runnable snippet using Ghastly. You can find more information and examples on the Ghastly website.

const { Client } = require('ghastly');

function ping() {
  async function handler() {
    return 'Pong!';
  }
  
  return {
    handler,
    triggers: ['ping'],
  };
}

const client = new Client({ prefix: '!' });

client.commands.add(ping);
client.login('token');