The code in this repository is no longer under active maintenance, and as such may not be functional, secure or fit for purpose. Deploy and use at your own risk.
A Discord bot made for the Swansea Gaming Society. Includes features like:
- Automatic channel renaming - Help identify what games are being played in which channel at a glance
- Game statistics tracking - Provides insights for server operators as to what games are popular
- Burst channels - Automatically create and delete voice channels if existing ones get full
This bot is not ready for production use out of the box, and is likely to require a number of source tweaks to fit your exact application. There are unfortunately a number of areas where certain strings are hardcoded that make no sense outside of the bot's original deployment, which you will need to change for your use case.
The bot is not designed to be connected to multiple servers at this time, so if you want the bot to be in different servers, you'll need to run multiple instances.
Make sure you have at least the following installed:
- Node.js version 12 or higher.
- PostgreSQL
The bot has only ever been tested to run on Linux; if you can get it to run on Windows, send in a pull request with updated docs!
- Clone the repository and check out whatever version you want to use (for now, master is your only real option)
- Run
yarnin the directory you cloned into to grab the dependencies - Copy the
.env.examplefile to.envand set the configuration directives appropriately. - Import the schema file in the root of the repository into an empty database in Postgres. Make sure the owner of the tables, sequences and roles is set appropriately for what you set in the env file.
- Start the bot with
node index.jsand pray.
To test the bot with eslint run yarn test. This will run eslint over all the code. If you'd rather run this test
and then launch the bot run yarn run dev which will do this for you as well.