A simple Discord.js bot base.
This is an extremely simple Discord.js bot base with a config loader / validator, a command handler, and a simple ping command. All code should be pretty self-explanatory.
- Fork the repo
- Clone your newly made fork
- Run
npm ci
to install all dependecies - Copy the
.env.example
file that is provided to.env
and fill out all provided variables - Run the bot with
npm start
It should be pretty simple to make your own commands, expand the command handler, etc.
You can pretty easily build a docker image out of your bot using the provided Dockerfile
and Dockerfile-native
. To build your docker image, run the following inside your project:
docker build . -t myname/my-cool-bot
If you have native dependencies that require a full node environment to install, either replace Dockerfile
with Dockerfile-native
or run the following:
docker build -f Dockerfile-native . -t myname/my-cool-bot
Then to run the built docker image, attach to its virtual terminal, and read from your .env
file, run the following:
docker run -it --env-file .env myname/my-cool-bot
Hit ^C to kill the bot while it's running. See more about running docker images on the official docs for docker run.
I've included a sample docker-compose-example.yml
file which you can use to set up a docker-compose.yml
file to use with, well, docker-compose. This allows you to easily run a number of instances of the same bot with different tokens, prefixes, etc, which is great if you want to do things like managed hosting for customers who pay you to host bots for them.
Just copy docker-compose-example.yml
to docker-compose.yml
, tweak the environment variables and service names for each instance you want to run, and then use the following for reference:
# if you want to see terminal output:
docker-compose up
# otherwise, run this to create the containers detached:
docker-compose up -d
# to start/stop:
docker-compose start
docker-compose stop
# to remove the containers:
docker-compose down