zatura24 / chorusdownloader

A discord bot for downloading songs from repositories using the Chorus API

🎶 Chorus Downloader 🎶

Chorus Downloader is a discord bot for downloading songs of Chorus like repositories to local/remote filestorages.

This bot is based on the API created by Paturages: Chorus.

Avaiable commands

Following is a list of available commands.

$ping pong

$api [url] Gets or Sets the api url.
Note: requires 'admin' role

$search <search_string> [query_type] Searches the api for a given 'search_string'. Optionaly a query_type can be supplied. These are currently the same as documented in Paturages API.
Note: If more than one word is needed for the search, the search_string needs to be encapsulated in quotes.

Currently the following query_types are available:

• name
• artist
• album
• genre
• charter
• tier_band
• tier_guitarghl
• diff_guitar
• hasForced

Install

Make sure docker is running in your machine, or remote server, and you have created a discord bot. A tutorial to create your discord bot can be found here: Creating a bot account. Also make sure to create an Admin role inside your discord server, because this necessary for setting the url.

First create a docker image:

docker build -t chorusdownloader .

Secondly run the docker image:

docker run -d --name ChorusDownloader --env DISCORD_TOKEN=xxxx chorusdownloader

Note: As a default there is no volume attached to the download folder. You must add one yourself with the -v parameter.

Environment variables

The following environment variables can be set during the docker run command:

variable	required	default
DISCORD_TOKEN	yes

To add these to the docker run command use --env KEY=VALUE

Config file settings

Located in the config.ini the following configurations are available:

variable	required	default
apiUrl	false	https://chorus.fightthe.pw/api/
chunkSize	true	8192
defaultTimeout	true	15.0
discordCommandPrefix	true	$
downloadedSongsCacheFile	true	./downloaded_songs.txt
downloadPath	true	./download