1.0.1 • Published 5 years ago

discord.js-chatbot v1.0.1

Weekly downloads
6
License
ISC
Repository
github
Last release
5 years ago

A Discord.js Chat Bot

This is a simple chatbot for Discord.js clients using the cleverbot.io API. If you need help or just want to chat, feel free to join the discord server.

Installation

  1. Get your API User and Key from https://cleverbot.io/keys
  2. Have a Discord app setup and a bot token
  3. In your working directory: npm i discord.js-chatbot --save

Basic Usage

// First we require the Discord.js library.
const Discord = require("discord.js");

// Now we make a new Discord.js Client.
const client = new Discord.Client();

// Lets put the chat bot data in the client for easier usage.
client.chat = require("./index.js");

// Now, we start the chatbot!
// Make sure your credentials are correct.
// cleverUser, cleverKey and cleverNick are all required options.
client.chat.ChatBot(client, {
  cleverUser: "cleverbot.io/keys user",
  cleverKey: "cleverbot.io/keys key",
  // cleverNick will be the session the bot uses from cleverbot.io.
  // This can be whatever you like.
  cleverNick: "session name"
});

// Now we login with the actual bot!
client.login("<super secret bot token here>")

Options

There are a few other options you can pass as well. However, these are not needed.

OptionTypeDefaultDescription
watchMentionBooleantrueWhether or not to watch for messages starting with the clients mention.
watchNameBooleantrueWhether or not to watch for messages starting with the clients username.
enableTypingBooleantrueWhether or not to send typing requests while fetching a response from cleverbot.
ignoredServersArray An Array of sever ID's to ignore from the chat bot.
ignoredChannelsArray An array of channel ID's to ignore from the chat bot.

Custom Options Example

const Discord = require("discord.js");
const client = new Discord.Client();
client.chat = require("./index.js");

client.chat.ChatBot(client, {
  cleverUser: "cleverbot.io/keys user",
  cleverKey: "cleverbot.io/keys key",
  cleverNick: "session name",
  enableTyping: false,
  ignoredServers: ["427239929924288532"],
  ignoredChannels: ["441425044351090689", "441393041824022528"],
  watchName: false,
  watchMention: false
  // I put those both to false for show, actually doing this will result in an error.
});

client.login("<super secret bot token here>")