This project aims to evolve into a simple discord bot, that provides some functionality that I wanted a bot to have. Most importantly, the project provides a framwork to program new functionality with as few lines of new code as possible.
To run this bot, you may want to use docker. The bot is tested on docker version 19.03.13 and docker-compose version 1.27.4. Alternatively, you can manually install Node.js and MariaDB and run it that way. This is highly discouraged though.
To start the bot, clone the repository and add the following environment files in the repository root and fill in the information:
The file format is key=value with one key-value pair per line.
| Attribute | Value |
|---|---|
| SPOTIFY_ID | The spotify client ID of your application |
| SPOTIFY_SECRET | The spotify secret of your application |
| DISCORD_TOKEN | The discord bot token of your discord bot |
| REDIRECT_URI | The redirect URI that spotify will use for the OAuth2.0 authorization. This URI must lead to the registration docker container and has to be registered in the spotify settings as redirect URI |
| (optional) LOGLEVEL | The level of information displayed in the console. Can either be error, warn, info (default), verbose, debug or silly. |
| Attribute | Value |
|---|---|
| MYSQL_ROOT_PASSWORD | The root password for you mariadb instance. Can be used fairly randomly, as it will not be used and the database should not be accessible from outside the network. |
| MYSQL_DATABASE | The name for the database used. Currently, this needs to be set to "discus" |
| MYSQL_USER | The username of the user the bot uses to access the database defined in MYSQL_DATABASE. |
| MYSQL_PASSWORD | The username of the user the bot uses to access the database defined in MYSQL_DATABASE. |
To start the bot, execute docker-compose up --build in the root directory of the repository. This should start all the containers. If nothing goes wrong, the bot will be online and taking requests.
Contains the core commands and functionality.
| Command | Parameters | Description |
|---|---|---|
| $ping | none | Echoes "pong" |
Contains commands and events for creating spotify listening parties. Listening parties are text channels associated with the creators spotify account. Members of the channel can post song links which will be added to the hosts playback queue.
| Command | Parameters | Description |
|---|---|---|
| $registerMe | none | Sends a registration link to the user typing the command. If clicked on, the user tokens will be added to the database. |
| $createParty | Discord mentions (@user list) | Creates a listening party that controlls the spotify queue of the command issuer. |
| Songlink | none | If sent in a party channel, the song will be added to the playback queue of the channel owner. It doesn't matter, if there is other text in the message, as long as the link is clickable. This allows you to use the Spotify share option on mobile. |