Skip to content

Latest commit

 

History

History
41 lines (34 loc) · 1.57 KB

README.md

File metadata and controls

41 lines (34 loc) · 1.57 KB
Raw

SherBot

SherBot A lightweight skeleton for a Discord bot that can be used to create any bot! It has all the boilerplate code done for you, and is fully modular! You can add commands, events, and timed tasks - all fully modular!

Requirements

  • Node.js
  • js-logger
  • discord.js
  • discord.js-light

Usage

Don't use the example files given - any command named example.*.js won't be loaded by the bot! Copy the example files and rename them to use.

Also make sure to rename "config.template.json" to "config.json" - this is where your token goes, as well as other data you want to use!

Commands

This folder stores commands (duh). Any files that end with ".js" in the commands folder will be registered as slash commands by the bot. Follow the template given in the "example.js" file.

Events

This folder stores the logic for an event. Any files that end with ".js" in the events folder will be registered as on or once events to the Discord API. Follow the template given in the "example.js" file.

Tasks

This folder stores functions. Any files that end with ".js" in the tasks folder will be registered as functions to be executed at certain intervals. Follow the template given in the "example.js" file.

Embeds

This folder is used to store embeds in their own files to allow cleaner code. These can be imported in files and used as neccessary. These embeds can be used in conjuction with the util functions.