Custom DiscordBot

Custom DiscordBot made for the private BD Discord server. This is just a fun project several teammates work on occasionally in our free time. This is currently only available to those on the server, however a deployable version for anyone to use is planned.

How to use

/help lists the available commands in the current context (Discord server or DM).

To view the description and parameter information for a particular command, initiate a slash command by typing / followed by the command on a Discord server.

Development/Self-Host

Install

1. git clone https://github.com/Kyle-Stadelmann/DiscordBot
2. cd DiscordBot
3. Ensure node is installed and node -v matches the version in .nvmrc (can use nvm use or nvm use [version] if nvm is installed)
4. npm install
5. Install ffmpeg onto your system and set the system environment variable FFMPEG_PATH to the install location.
6. cp .env.template .env
7. Fill out fields in .env file with API keys/secrets

Start in the development environment

In the development environment, the development bot specified in the .env file (DEV_BOT_TOKEN) will be used instead of the production one. Additionally, certain rules such as removing cooldowns are activated to make development smoother.

npm run start or npm run dev for hot-reload

Start in the production environment

In the production environment, the bot is launched using transpiled javascript in order to use less resources.

1. npm run build
2. npm run start-prod

Run Scripts

Scripts in src/scripts can be executed separately from the bot. These can be executed using tsx.

npx tsx [script-name]