vnftjs v1.2.10

(by old name vnft-commandhandler)
(vnftjs)

vnftjs

Discord CommandHandler for TypeScript or JavaScript

Table of Contents

• Classes
  • CommandHandler
    • prefix
    • loadCommands(path)
    • loadScripts(path)
    • enableHelp()
    • enableDebug()
  • Command
    • name
    • funct
    • addAlias(name)
    • addUserWhitelist(user)
    • addUserBlacklist(user)
    • addRoleWhitelist(role)
    • addRoleBlacklist(role)
    • description
    • usage
  • Script
    • funct
    • interval
• Examples
  • JavaScript
  • TypeScript

Class: CommandHandler

the extended discord.js Client

prefix

the prefix for the commands, . is set by default.

loadCommands(path)

loads all exported command instances of the specified path.

loadScripts(path)

loads all exported script instances of the specified path and triggers them after the client has successfully logged in.

enableHelp()

adds the .help command

enableDebug()

reloads the source file of a command before execution. allows editing commands while the bot is running.

Class: Command

name

the main trigger for the command (without prefix)

funct

the function that gets triggered with the call of the command.
parameters: (client: Client, message: Message, args: string)

Client: the discord client ( extended with the commandhandler )
Message: the message that triggered the command
args: the entire string after the commandname (e.g. .help ping → args:"ping")

addAlias(name)

alternative names for the command, which should also trigger it.

addUserWhitelist(user)

limites the use of the command to those who are described in the whitelist
as long as they are not in the blacklist

addUserBlacklist(user)

disallowes the use of the command to those who are described in the blacklist
even if they are in a whitelist

addRoleWhitelist(role)

restricts the use of the command to those described in the whitelist.
as long as they are not blacklisted.

addRoleBlacklist(role)

prohibits the use of the command by those described in the blacklist.
even if they are on a whitelist.

enableHelp()

adds the .help command

helpColor

sets the color of the richEmbed at the help reply

description

description of the command in .help <command>

usage

usage-description of the parameters in .help <command>

Class: Script

funct

the function that gets executed after the client has successfully logged in.
parameters: (bot: Client)

Client: the discord client ( extended with the commandhandler )

interval

time in ms in which the script-function should be repeated
(negative numbers are disabling the repeat, -1 is the default value)

Examples

JavaScipt

Structure for this example

.
├── main.js
├── commands/
│   ├── ping.js
│   ├── neko.js
│   └── setActivity.js
└── scripts/
    ├── startAsDnd.js
    └── tbd

Code

main.js

const { CommandHandler } = require("vnftjs");
const path = require("path");

const client = new CommandHandler();
client.prefix = "!";

client.loadCommands(path.join(__dirname, "commands"));

client.login("Discord Token");

commands/ping.js

const { Command } = require("vnftjs");

const pingCommand = new Command();
pingCommand.name = "ping";

pingCommand.funct = (client, message, args) => {
  message.reply("Pong!");
};

module.exports = pingCommand;

commands/neko.js

const { Command } = require("vnftjs");
const axios = require("axios");

const neko = new Command();
neko.name = "neko";
neko.addAlias("cat");

// ↓ !help gives out the description "Sends a picture of a cat" and !neko without arguments as usage
neko.description = "Sends a picture of a cat";
neko.usage = "";

neko.funct = async (client, message, args) => {
  var meow = await axios.get("http://aws.random.cat/meow");
  message.reply(meow.data.file);
};

module.exports = neko;

commands/activity.js

const { Command } = require("vnftjs");

const activity = new Command();
activity.name = "setActivity";
activity.addAlias("activity");

// ↓ only the user with the id "397063436049186818" can now execute this command
activity.addUserWhitelist(u => u.id == "397063436049186818");

activity.funct = async (client, message, args) => {
  await client.user.setActivity(args);
  message.reply(`Status Updated`);
};

module.exports = activity;

scripts/startAsDnd.js

const { Script } = require("vnftjs");

const status = new Script();

status.funct = client => {
  client.user.setStatus("dnd");
}

module.exports = status;

TypeScript

Structure for this example:

src/
├── main.ts
├── commands/
│   ├── ping.ts
│   ├── neko.ts
│   └── setActivity.ts
└── scripts/
    ├── startAsDnd.ts
    └── tbd

Code

main.ts

import { CommandHandler } from "vnftjs";
import * as path from "path";

const client = new CommandHandler();
client.prefix = "!";

client.loadCommands(path.join(__dirname, "commands"));

client.login("Discord Token");

commands/ping.ts

import { Command } from "vnftjs";
import { Client, Message } from "discord.js";

const ping = new Command();
ping.name = "ping";

ping.funct = (bot: Client, message: Message, args: string) => {
  message.reply("Pong");
};

export = ping;

commands/neko.ts

import { Command } from "vnftjs";
import { Client, Message } from "discord.js";
import axios from "axios";

const neko = new Command();
neko.name = "neko";
neko.addAlias("cat");

// ↓ !help gives out the description "Sends a picture of a cat" and !neko without arguments as usage
neko.description = "Sends a picture of a cat";
neko.usage = "";

neko.funct = async (bot: Client, message: Message, args: string) => {
  let meow = await axios.get("http://aws.random.cat/meow");
  message.reply(meow.data.file);
};

export = neko;

commands/setActivity.ts

import { Command } from "vnftjs";
import { Client, Message } from "discord.js";

const activity = new Command();
activity.name = "setActivity";
activity.addAlias("activity");

// ↓ only the user with the id "397063436049186818" can now execute this command
activity.addUserWhitelist(u => u.id == "397063436049186818");

activity.funct = async (bot: Client, message: Message, args: string) => {
  await bot.user.setActivity(args);
  message.reply(`Activity Updated!`);
};

export = activity;

scripts/startAsDnd.ts

import { Script } from "vnftjs";

const status = new Script();

status.funct = client => {
  client.user.setStatus("dnd");
}

export = status;