Skip to content

Our reading hall needed some robotic love, this was the result

License

Notifications You must be signed in to change notification settings

lesesalen/lesebot

Repository files navigation

lesebot

GitHub Actions Status

A small but useful Discord bot.

Table of Contents

Table of Contents

What

Because of the global COVID-19 crisis our university shut down our reading halls and I decided to create my own virtual reading hall with blackjack and hookers. As the server has grown we've added a couple utility bots here and there, some doing this and some doing that. I figured instead of having a growing problem of bots and their rights, we could instead just pile onto a single bot.

Installation

Configuration

Before any of the next steps, it's important to look at the .env.example file and see what you need to change, for more details look at the CONTRIBUTING documentation. You can follow this guide and copy the .env.example file to .env. Then you can simply change what you need to.

NB: The .env is ignored by git by default so that you never accidentally expose your application secrets, so make sure it is never added to your repo.

Production

NOTE: This bot is automatically deployed whenever a new commit is pushed to main, and once it is built and the Docker image is pushed the changes go live. This takes approximately four minutes from when a commit lands on main.

Automatically

For production, I recommend hosting the bot in a Docker container and running that. It is fairly straight forward: edit the deploy.sh file and change the name from lesebot to whatever you want it to be and then just run it from the command line ./deploy.sh. This will pull the latest version of the bot from the GitHub Docker Registry and deploy it.

If you want to do this manually you can look at the commands that are run in deploy.sh and run them yourself, just remember to build the bot locally first:

$ docker build -t <name> .
$ docker run --env-file .env -itd --restart unless-stopped --name <name> <name>

Note: You should probably omit the -d flag if you are developing locally as this launches it headless. Otherwise, you have to find the process ID and then view its logs.

Developing

For development, you need a good JavaScript IDE (Visual Studio Code or WebStorm are my recommendations) and Node (version 16.6 and above, note: due to requirements for Discord.js you must have at least v16.6), then simply run:

$ git clone [email protected]:sondr3/lesebot.git
$ cd lesebot
$ npm ci

NOTE: If you don't care about the test bot being able to run voice commands you can install it without the optional dependency sodium like so: npm ci --no-optional.

Once you have everything installed you can start developing. The easiest way to do this is to start the bot with npm dev to automatically reload the bot whenever the code changes.

Inspiration, help

License

MIT.