Files
ShiteMusicBot/README.md
T
2020-08-27 20:33:27 +02:00

57 lines
1.6 KiB
Markdown

# WIP - Shite Music Bot
[![Build Status](https://jenkins.roxedus.net/buildStatus/icon?job=MusicBot%2Fdev)](https://jenkins.roxedus.net/job/MusicBot/job/dev/)
[![MicroBadger](https://images.microbadger.com/badges/image/rnorge/music:dev-amd64.svg)](https://microbadger.com/images/rnorge/music:dev-amd64 "Get your own image badge on microbadger.com")
## Features
- Translations, get the bot in your preferred langauge!
- Round Robin style queue, you won't have to wait forever for your songs to play.
- Noice per server customization options.
- Toit embeds.
- More stuff to come?
- Lyrics command that sometimes gives the correct lyrics
- DJ roles
### Setup
1. Change or copy data/config.yaml.example to config.yaml
2. Create or find a [lavalink](https://github.com/Frederikam/Lavalink) server you can use.
3. Add your bot token and lavalink server.
4. Edit any other settings you want.
5. install requirements `python -m pip install -r requirements.txt`
6. run the bot :)
### Docker
### Compose Example
````yaml
version: '3'
networks:
internal:
driver: bridge
services:
backbone:
hostname: lavalink
image: fredboat/lavalink:dev
ports:
- 2333:2333
networks:
internal:
aliases:
- lavalink
volumes:
- /compose/BottStack/lavalink/application.yml:/opt/Lavalink/application.yml
bot:
container_name: ProdMaster
image: rnorge/music
networks:
- internal
command: python3 bot.py
volumes:
- /compose/BottStack/ProdBetaMaster/script:/diks
- /compose/BottStack/ProdBetaMaster/data:/app/data
````