ConfrerieDuKassoulait/KassouBot
ConfrerieDuKassoulait/KassouBot
Archived
2
0
Fork 0
Code Issues 3 Pull requests Projects Releases Wiki Activity

Adding doc according with new Lavalink requirements

Browse source
This commit is contained in:
Mylloon 2021-08-06 13:16:26 +02:00
parent 7137cdcc92
commit 69b045480b
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -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.