Open Source Ecosystems

Inspired to create stand-alone boiler-plate after contributions I had made to a private bot repository from hailthekid

New Features:

Application re-factors:
- Object oriented implementation and Bot class.
- Flattened directory structure
- Registering of event listeners and commands now follow a more common pattern
- Clear export / import structure
Development Tools:
- Internal and external documentation for important utilities
- CLI tool for registering commands with Discord API
- nodemon restarts application automatically during development
- Pre-commit hooks:
  - eslint - linting
  - prettier - formatter
- Clear logging for additional information using debug library.

Installation

Set up your Github account and install git.
Clone the repository.
```
 git clone [email protected]:dmartinezgamboa/base-discord-bot-app.git
```
https://github.com/dmartinezgamboa/base-discord-bot-app

Fork the repository and set up your remote on github.

 git remote add {your_name} [email protected]:{your_git_username}/bot

Create your own discord bot application.

https://discord.com/developers/applications
Setup environment variables.
```
 TOKEN="{YOUR_BOT_TOKEN}"
 CLIENT_ID="{YOUR_BOT_APPLICATION_ID}"
```
Create .env file in the root directory and paste variables

use .envSample as an example
Install node dependencies.
```
 npm install
```
Start the Bot application.
```
 npm start [--register] 
```
- --register: Registers currently implemented slash commands with Discords API globally. See Registering Commands for more options.
  
  Registering is only necessary for the first time or when command data has been updated.

Development

Setup:

Install development dependencies.
```
 npm install -D
```
Install pre-commit hooks.
```
 npm run prepare
```
Run the app in development mode.
```
 npm run dev
```
Options:
- --debug Adds logging to stdout. For more options see Debug Logs

Adding Commands:

Create your command file in: `src/commands` directory, named `{myCommandName}.js`

const { SlashCommandBuilder } = require('discord.js')

const myCommand = {
data: new SlashCommandBuilder()
    .setName('myName')
    .setDescription('my description'),
execute: execute
}

const execute(interaction) => { ... }

module.exports = { myCommand }

Add your new command to the commands index: `src/commands/index.js`.

const { myCommand } = require(./commands.js')'

module.exports = [myCommand, ...]

Done! The bot will set this command on the client during initialization.

Reference: https://discordjs.guide/creating-your-bot/command-handling.html#loading-command-files

Registering Commands:

Usage

For any npm command: (start, run dev etc):

npm start [{--register | --register-only} [--guild-id=<guild_id>] [--clear]]

--register: If only option, registers the currently implemented commands globally with Discord API.
--register-only: Same operation as --register except the application will exist once registration is complete.
--guild-id: If provided along with a --register* option, it will register the currently implemented commands only for that specific guild.
--clear: If provided with a --register* option, will remove any registered commands for that scope (Will be global or guild specific depending on additional options.)