Commands

This bot has a few example commands which can be modified as needed.

Help Command

A /help command to get help on different areas of the bot or to contact support:

Info Command

A /info command to get information about the bot or links to different resources.

Test Command

A generic command, /test, which can be copied to create additional commands.

Dev Command

A /dev command which can only be run by the bot developer. Shows developer information, but can be extended to perform developer-only actions.

Setup

1. Copy example config files.
   • Navigate to the config folder of this project.
   • Copy all files ending in .example.json and remove the .example from the copied file names.
     • Ex: config.example.json should be copied and renamed as config.json.
2. Obtain a bot token.
   • You'll need to create a new bot in your Discord Developer Portal.
     • See here for detailed instructions.
     • At the end you should have a bot token.
3. Modify the config file.
   • Open the config/config.json file.
   • You'll need to edit the following values:
     • client.id - Your discord bot's user ID.
     • client.token - Your discord bot's token.
4. Install packages.
   • Navigate into the downloaded source files and type npm install.
5. Register commands.
   • In order to use slash commands, they first have to be registered.
   • Type npm run commands:register to register the bot's commands.
     • Run this script any time you change a command name, structure, or add/remove commands.
     • This is so Discord knows what your commands look like.
     • It may take up to an hour for command changes to appear.

Start Scripts

You can run the bot in multiple modes:

1. Normal Mode
   • Type npm start.
   • Starts a single instance of the bot.
2. Manager Mode
   • Type npm run start:manager.
   • Starts a shard manager which will spawn multiple bot shards.
3. PM2 Mode
   • Type npm run start:pm2.
   • Similar to Manager Mode but uses PM2 to manage processes.