diff options
| -rw-r--r-- | README.md | 71 | ||||
| -rw-r--r-- | assets/demo.jpg | bin | 0 -> 280328 bytes | |||
| -rw-r--r-- | assets/logo.jpg (renamed from assets/songlinkr.jpg) | bin | 270084 -> 270084 bytes |
3 files changed, 71 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ea24e3a --- /dev/null +++ b/README.md @@ -0,0 +1,71 @@ +<center> +<img src="assets/logo.jpg" alt="Songlinkr logo" width=250><br> +<h1>Songlinkr</h1> + +A discord bot for universal music links (using [song.link][1]) + +</center> + +## About + +Have you ever wanted to share a song/album/artist on discord but you use +[Tidal][2] and all your buddies use [Spotify][3]? This this is what this bot +is for! Just host it, and add it to your discord server! + +**Here's an example of it in action**: + +<center> +<img src="assets/demo.jpg" width="90%"> +</center> + +## Configuration + +Before hosting this locally, you will need to configure yourself a discord bot +and prepare a spot to store it's personal info. Here's how to do so: + +1. From within this repository, run the following: +```sh +mkdir -p secrets && touch secrets/token +``` +2. Head to https://discord.com/developers/applications and create a new + application +3. Head to the bot page and create your bot: + - Give it a name + - Feel free to use the image in `assets/logo.png` as it's icon + - Click the `Reset Token` and copy the token to the `secrets/token` file + you created earlier. + - Turn on the `Message Content Intent` field +4. Configure your bot's OAuth2 settings: + - Tick the `bot` scope (a new dialog will appear) + - Tick the required bot permissions (`Send Messages`, `Read Message History` and + `Embed Links` should be the only ones required) + +Congrats! Your are now ready to start hosting your bot! + +## Installation + +The simplest way to install this is probably using the included +`docker-compose.yml` as it will also configure mounting secrets +using the `secrets` directory. + +If you don't have docker, you can also run compile it yourself using +```sh +go mod download && go mod verify +go build -o songlinkr cmd/songlinkr/main.go +``` + +Please note that this method will require you to manually start the bot +when your computer boots up (and manually restart it if it ever crashes). +You can specify any directory to store the secrets in by passing the +`--secrets-path` argument on launch. + +## Contributing + +If you would like to contribute to this project, feel free to fork it and +submit a patch via `git-send-email`. If you use github, you can also submit a pull +request. + +[1]:https://song.link +[2]:https://tidal.com +[3]:https://spotify.com +[4]:https://go.dev diff --git a/assets/demo.jpg b/assets/demo.jpg Binary files differnew file mode 100644 index 0000000..73eff43 --- /dev/null +++ b/assets/demo.jpg diff --git a/assets/songlinkr.jpg b/assets/logo.jpg Binary files differindex 8d85939..8d85939 100644 --- a/assets/songlinkr.jpg +++ b/assets/logo.jpg |
