https://github.com/colinwilliams91/discord-bot
Discord Bot Boilerplate | Bootstrap | Template
https://github.com/colinwilliams91/discord-bot
api bot discord discord-bot discord-js integration webhook
Last synced: about 2 months ago
JSON representation
Discord Bot Boilerplate | Bootstrap | Template
- Host: GitHub
- URL: https://github.com/colinwilliams91/discord-bot
- Owner: colinwilliams91
- License: mit
- Created: 2023-07-02T17:58:07.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-12T22:02:52.000Z (almost 3 years ago)
- Last Synced: 2025-01-07T22:46:32.975Z (over 1 year ago)
- Topics: api, bot, discord, discord-bot, discord-js, integration, webhook
- Language: JavaScript
- Homepage:
- Size: 14.6 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Discord Bot/Integration Template
### Description:
This repo is a Discord Bot Bootstrap with all the necessary setup configured. Just plug in your [variables](./example.env)
and start building event listeners/handlers in the [index.js](./src/index.js)
the [setup](https://github.com/colinwilliams91/discord-bot#setup) below walks through the Discord-side integration steps.
### [API](https://old.discordjs.dev/#/docs/discord.js/main/general/welcome)
### Spin-up
_if you have nodemon installed globally_
```bash
npm i
nodemon
```
### Setup:
[Discord Docs Home/Guide/API](https://discord.js.org/)
- visit the **[Discord Developer Portal](https://discord.com/developers/applications)**
- click **"New Application"** to create the bot/integration container
- name the Application and agree to ToS
- configure **"General Information"** if needed
- click **"Bot"** in left-side panel
- toggle `PUBLIC BOT` on `||` off
- toggle on all **3** "Priveleged Gateway Intents"
- select **"Bot Permissions"** as needed
- make sure to click "SAVE" to changes in pop-up
- click **"OAuth2"** in left-side panel
- click **"URL Generator"**
- select **"bot"** for bot scopes and permissions
- select **"applications.commands"** for `/` commands permissions if needed (to interact with bot in Discord)
- this will open the `BOT PERMISSIONS` section
- select **"Administrator"** for all permissions `||` specify permissions here
- click **"Copy"** button in lower-right to copy `GENERATED URL`
- paste copied **URL** into Discord Server's channel `||` in the web browser
- click pasted **URL** to invite Bot to Discord Server
### Environment:
- rename `example.env` to `.env`
- replace `TOKEN=` value with the Token from the Bot you want to build in your [Application Container](https://discord.com/developers/applications)
- it will be located in the "Bot" section in the left-side panel
### Notes:
`src/index.js`
```js
import { Client, IntentsBitField } from "discord.js";
```
- this will import the Client from discord library and IntentsBitsField...
- see [DOCS](https://github.com/colinwilliams91/discord-bot#docs): section for how Intents work
### [DOCS](https://old.discordjs.dev/#/docs/discord.js/main/general/welcome):
##### [List of Intents](https://discord.com/developers/docs/topics/gateway#list-of-intents)
We must explicitly define "Intents" in the options object to our Client generator function.
Each "Intent" (e.g.; Guilds) will give access to a list of events (see documentation)
that our bot will gain access to by passing in. (SO OUR BOT WILL KNOW WHEN THESE EVENTS OCCUR)
### IMPORTANT:
_A "GUILD" in Discord Development represents a SERVER_
```js
const client = new Client({
intents: [
/* IntentsBitField.Flags.Guilds, */
/* intents here... */
],
});
```
### If you wish to start from scratch:
```bash
npm init -y
# --> inside package.json: "main": "src/index.js"
mkdir src
cd src
touch index.js
cd ..
npm i discord.js dotenv
```
# TERMS OF USE
_By using this repository in anyway you are agreeing to follow the Code of Conduct listed [here](https://github.com/colinwilliams91/discord-bot/blob/main/CODE_OF_CONDUCT.md)_