75 lines
3.2 KiB
Markdown
75 lines
3.2 KiB
Markdown
<h1 align="center">
|
|
<br>
|
|
<img src="guava.png" width="300" alt="Guava Image"></a>
|
|
<br>
|
|
Guava<br>
|
|
</h1>
|
|
|
|
<h3 align="center">
|
|
Dead simple Discord music bot
|
|
<br>
|
|
<a href="https://pkrm.dev">Invite Guava</a>
|
|
</h3>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/Rapptz/discord.py/">
|
|
<img src="https://img.shields.io/badge/discord-py-blue.svg" alt="discord.py">
|
|
</a>
|
|
<a href="https://github.com/psf/black">
|
|
<img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style: Black">
|
|
</a>
|
|
<a href="https://makeapullrequest.com">
|
|
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg">
|
|
</a>
|
|
<a href="https://makeapullrequest.com">
|
|
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg">
|
|
</a>
|
|
</p>
|
|
|
|
# Overview
|
|
|
|
Guava is a Discord music bot with support for multiple different music and video streaming platforms. Guava is a part of >150 Discord servers and currently supports these services:
|
|
|
|
- Spotify
|
|
- YouTube (videos and streams)
|
|
- SoundCloud
|
|
- Bandcamp
|
|
- Deezer
|
|
- Twitch Streams
|
|
- Vimeo
|
|
|
|
Getting started is easy, simply invite Guava to your server and run `/help` to see what all Guava has to offer.
|
|
|
|
# Want to self-host?
|
|
Guava is built on Python and requires a Lavalink node running release `v4` or higher with the LavaSrc plugin. If you would like to configure Guava and run it on your own, follow the steps below.
|
|
|
|
*P.S. Some information on starting your own lavalink node can be found [here](#lavalink-information)*
|
|
|
|
On first run you will likely get a critical warning in your console, don't worry, this is expected. It will automatically create a `config.ini` file for you in the root of the directory with all of the necessary configuration options.
|
|
|
|
Fill out the configuration options, then re-run the bot, and everything *should* just work. For information on each configuration option, look below.
|
|
|
|
Field | Description
|
|
--- | ---
|
|
TOKEN | The token for your bot. Create a bot at [discord.com/developers](https://discord.com/developers)
|
|
BOT_COLOR | Hex color code that will be used for the color of message embeds
|
|
HOST | Host address for your Lavalink node
|
|
PORT | Port for your Lavalink node
|
|
PASSWORD | Password to authenticate into the Lavalink node
|
|
|
|
# Lavalink Information
|
|
|
|
As previously state, a Lavalink node running at least `v4` with the LavaSrc plugin is required. Due to the plugin requirement, it is unlikely that you will be able to use a free/public Lavalink node.
|
|
|
|
For instructions on setting up a Lavalink node, look [here](https://lavalink.dev/getting-started/), and for instructions on the LavaSrc plugin, look [here]().
|
|
<br>
|
|
*P.S. Only the Spotify, Deezer, and YouTube sources/search providers are needed.*
|
|
|
|
It is also highly recommended to setup IPv6 rotation in order to avoid blocks and other issues. There are helpful guides for this both [here](https://blog.arbjerg.dev/2020/3/tunnelbroker-with-lavalink) and [here](https://gist.github.com/Drapersniper/11fee08f91ea7174e0d8af12496f3443).
|
|
|
|
An example of my personal `application.yml` file can be found [here](https://github.com/packetparker/Guava/applcation.yml.example).
|
|
|
|
<br>
|
|
<br>
|
|
|
|
If you have any questions, feel free to email at [contact@pkrm.dev](mailto:contact@pkrm.dev). Thank you for checking out Guava, and happy coding. |