From 69b045480bbea1ad1275d0a577a5a3af75feee40 Mon Sep 17 00:00:00 2001 From: Mylloon Date: Fri, 6 Aug 2021 13:16:26 +0200 Subject: [PATCH] Adding doc according with new Lavalink requirements --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 78edf9e..7b496e7 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ [![Build](https://img.shields.io/gitlab/pipeline/ConfrerieDuKassoulait/KassouBot/dev?style=for-the-badge)](https://gitlab.com/ConfrerieDuKassoulait/KassouBot/container_registry) ## __Setting up__ -You have to replace `TOKEN_DISCORD`, `PREFIX`, `TOKEN_GENIUS`, `TOKEN_REDDIT_CLIENT_ID`, `TOKEN_REDDIT_CLIENT_SECRET`, `TOKEN_REDDIT_USER_AGENT` and [`TIMEZONE`](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) with your desired values. You must also specify a path to the folder where the database will be.\ -With a [docker-compose](https://gitlab.com/ConfrerieDuKassoulait/KassouBot/-/blob/main/docker-compose.yml) or in command line: +You have to replace `TOKEN_DISCORD`, `PREFIX`, `TOKEN_GENIUS`, `TOKEN_REDDIT_CLIENT_ID`, `TOKEN_REDDIT_CLIENT_SECRET`, `TOKEN_REDDIT_USER_AGENT` and [`TIMEZONE`](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) with your desired values. You must also specify a path to the folder where the database will be. +With a [docker-compose](https://gitlab.com/ConfrerieDuKassoulait/KassouBot/-/blob/main/docker-compose.yml) or in command line: ``` docker run -d \ --name="KassouBot" \ @@ -42,5 +42,9 @@ To find Genius token, go to [this site](https://genius.com/api-clients), `login ## __Launching locally__ If you want to run it without Docker, create an .env file to store variables in the root folder (there is an example [here](https://gitlab.com/ConfrerieDuKassoulait/KassouBot/-/blob/main/.envexample)). -Install ffmpeg by doing `sudo apt install ffmpeg` and all the requirements by doing `python3 -m pip install -r requirements.txt` + +Install ffmpeg by doing `sudo apt install ffmpeg` and all the requirements by doing `python3 -m pip install -r requirements.txt`. + +Then if youre using music, download Lavalink v3.3.2.5 in the `src` folder by running this in root folder `curl -sLo src/Lavalink.jar https://github.com/freyacodes/Lavalink/releases/download/3.3.2.5/Lavalink.jar`. + Simply run `python3 main.py` inside the `src` folder to launch the bot in the repo folder.