joeyahines
/
spoticord
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
15 Commits
2 Branches
0 Tags
569 KiB
Rust 96%
Dockerfile 2%
PLpgSQL 1.8%
Shell 0.2%
 
 
 
 
Go to file
DaXcess a37daa23a0
Update COMPILING.md 		2022-11-07 19:05:50 +01:00
.cargo Build compat with Windows 2022-11-07 15:07:40 +01:00
src Humble beginnings for documentation 2022-11-07 16:54:41 +01:00
.dockerignore Uhm so yeah here's some c o d e 2022-10-31 22:46:34 +01:00
.gitignore Uhm so yeah here's some c o d e 2022-10-31 22:46:34 +01:00
.rustfmt.toml initial commit 2022-10-18 22:59:32 +02:00
COMPILING.md Update COMPILING.md 2022-11-07 19:05:50 +01:00
Cargo.lock Uhm so yeah here's some c o d e 2022-10-31 22:46:34 +01:00
Cargo.toml No unwind? 2022-11-07 16:57:19 +01:00
Dockerfile Uhm so yeah here's some c o d e 2022-10-31 22:46:34 +01:00
LICENSE Uhm so yeah here's some c o d e 2022-10-31 22:46:34 +01:00
README.md Humble beginnings for documentation 2022-11-07 16:54:41 +01:00

README.md

Spoticord

Spoticord is a Discord music bot that allows you to control your music using the Spotify app. Spoticord is built on top of librespot (with tiny additional changes), to allow full control using the Spotify client, with serenity and songbird for Discord communication. Being built on top of rust, Spoticord is relatively lightweight and can run on low-spec hardware.

How to use

Official bot

Spoticord is being hosted as an official bot. You can find more info about how to use this bot over at the Spoticord website.

Environment variables

Spoticord uses environment variables to configure itself. The following variables are required:

  • DISCORD_TOKEN: The Discord bot token used for authenticating with Discord.
  • DATABASE_URL: The base URL of the database API used for storing user data. This base URL must point to an instance of the Spoticord Database API.
  • SPOTICORD_ACCOUNTS_URL: The base URL of the accounts frontend used for authenticating with Spotify. This base URL must point to an instance of the Spoticord Accounts frontend.

Additionally you can configure the following variables:

  • GUILD_ID: The ID of the Discord server where this bot will create commands for. This is used during testing to prevent the bot from creating slash commands in other servers, as well as getting the commands quicker. This variable is optional, and if not set, the bot will create commands in all servers it is in (this may take up to 15 minutes).
  • KV_URL: The connection URL of a redis-server instance used for storing realtime data. While not required, not providing one will cause the bot to spit out quite a bit of errors. You might want to comment out those error lines in main.rs.

Providing environment variables

You can provide environment variables in a .env file at the root of the working directory of Spoticord. You can also provide environment variables the normal way, e.g. the command line, using export (or set for Windows) or using docker. Environment variables set this way take precedence over those in the .env file (if one exists).

Compiling

For information about how to compile Spoticord from source, check out COMPILING.md.

Contact

Discord Shield

If you have any questions, feel free to join the Spoticord Discord server!

License

Spoticord is licensed under the Apache License 2.0.