discordselfbot v0.0.2

discord-selfbot

How to run

1. Clone the repo or use npm

$ git clone https://github.com/megadrive/discord-selfbot

$ npm install discordselfbot

2. Install dependencies

$ npm install

3. Create a config file by making a copy of config.json.example and renamed it to config.json. If you want to use the weather command, you must obtain both a Google Maps Geocoding API key and a Dark Sky API key. Without these weather will emit a warning on use.

4. Run the bot!

$ npm start

Creating your own commands

As of writing, a command has three exports. An object on the exports variable itself, a help function and a run function. Always include 'use strict' to avoid complications.

exports should contain an object with an aliases array and event which is a string.

aliases is an array of anything that you want this to fire from. So, given the default prefix of _, calling _triggers, _to_ or _fire will cause this command to run. One caveat is that if you double-up on command triggers, the later loaded will overwrite the older. Generally speaking, if your command file starts with 'a' and your 'z' function has a trigger of 'a', calling _a will run the command 'z'.

event is a string that you will nearly definitely not need to change. If you do, you will need to create a new bot.on() function in app.js. Open an issue if you need it.

module.exports = {
  aliases: ['triggers', 'to', 'fire'],
  event: 'message'
}

This next block is the help function that is used when calling a function with the --help flag. usage is an array, add another if your command has more than one usage. See replace.js for an example.

module.exports.help = function () {
  let conf = require('../config')
  return {
    description: `Your command's description.`,
    usage: [`${conf.prefix}${module.exports.aliases[0]} your usage information.`]
  }
}

This is the crux of your command. Do whatever you need to here.

module.exports.run = function (message) {
	// your code to enact here
}

Full example:

'use strict'

module.exports = {
  aliases: ['triggers', 'to', 'fire'],
  event: 'message'
}

module.exports.help = function () {
  let conf = require('../config')
  return {
    description: `Your command's description.`,
    usage: [`${conf.prefix}${module.exports.aliases[0]} your usage information.`]
  }
}

module.exports.run = function (message) {
	// your code to enact here
}