0.9.9 • Published 7 years ago

xtremebot v0.9.9

Weekly downloads
1
License
MIT
Repository
github
Last release
7 years ago

XtremeBot

Welcome to the XtremeBot official repo, this shit contains the source of XtremeBot (the newest, and broken version)

Usage

const { XtremeBot } = require('./xtremebot/');
const { Command } = require('./xtremebot/commands/Command.js');

const myBot = new XtremeBot({
	debug: 0, // Debug level, probably ignored
	typeTime: 2500, // How long to type (in ms)
	prefix: 'x.', // The prefix, the bot will also use mentions as a prefix
	name: 'Bot', // Name of the bot
	default: true, // Use the dankest, default commands?
	owners: [], // List of owner IDs
	version: '0.0.1', // Version of le bot
	status: 'online', // online, dnd, idle, invisible
	emoji: false, // Use global emojis?
	invalid: false, // Say invalid command?
	discord: 'discord.js', // The require() to use, for custom libs or specific D.JS version
	token: '', // The token of the bot
	reactions: false, // (currently ignored) Respond to commands with reactions, :x: for error, :no_entry: for a non-owner trying to access an owner command, etc.
});

//WARNING: It is suggested that you know some JavaScript before attempting to write your own commands
myBot.addCommand(class MyCommand extends Command {
	constructor() {
		super(nameOfCommand, usageOfCommandOrJustNullIfThereIsNone, descriptionOfCommand, canOnyBeUsedByOwners, canOnlyBeUsedInGuilds);
	}
	
	execute(theMessage, theArguments, theBot) {
		...
	}
});

CLI

XtremeBot has a messy CLI. If you call index.js with key value argument lists, e.g. node index.js token <mytokenhere> prefix !, then it will set up the config to have your token and prefix automatically set.

--key value & --key=value arguments

This is doable but I'm more focused on JSDoc and making a relatively good bot.

Documentation

Documentation isn't available yet, as we are still adding JSDoc to all of our files.