/caroline

The Discord singer.

Primary LanguageGoMIT LicenseMIT

caroline

Github Actions Docker Pulls MIT License

The Discord singer.

Installation

Go version < 1.16

$ go get -u github.com/daystram/caroline/cmd/caroline

Go 1.16+

$ go install github.com/daystram/caroline/cmd/caroline@latest

Requirements

To function properly, the following tools and library must be installed:

Usage

After providing the required configuration, the bot can simply be run as follows:

$ caroline

Docker

Instead of installing the command itself, you can run the bot via Docker:

$ docker run --name caroline --env-file ./.env -d daystram/caroline

Configuration

The bot could be configured by setting the following environment variables.

Name Description Default Required
BOT_TOKEN Discord Bot token ""
SP_CLIENT_ID Spotify client ID ""
SP_CLIENT_SECRET Spotify client secret ""
DEBUG_GUILD_ID Discord debug Guild ID ""

License

This project is licensed under the MIT license.