eris-classis
v1.0.5
Published
A simple framework for Eris.
Downloads
4
Readme
Classis
A very WIP Discord bot framework for the Eris library. Quite a mess and not even tested.
Usage
Here's some basic info on how to get Classis up and running.
First of all, install Classis with npm/yarn - run npm i eris-classis
or yarn add eris-classis
. Second, it's as simple as defining the bot and creating some commands.
Creating a bot
The following code can be used to create a bot with Classis.
const { Bot } = require("eris-classis");
const bot = new Bot({ token: "THE.BOT.TOKEN", prefix: "the bot's command prefix" });
If you do not include slow: true
in the bot settings, the bot should connect instantly without any extra code.
Creating commands
Commands are created using Bot#command
. The first argument is of the type Command
- you can view this in types.d.ts
.
Example:
bot.command({
name: "test",
perm: 0,
description: "Tests the bot.",
usage: "test",
example: "test",
aliases: ["testy"],
exec: (msg, suffix) => {
msg.channel.createMessage(`You said "${suffix || "nothing"}".`);
}
});
This would create a command able to be called via the prefix and 'test'. If the prefix was '!', a user could type !test this is the suffix
for the output of You said "this is the suffix"
.