Add documentation
This commit is contained in:
parent
39026bb4e0
commit
b5575f410e
75
README.md
Normal file
75
README.md
Normal file
@ -0,0 +1,75 @@
|
||||
<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.
|
||||
118
application.yml.example
Normal file
118
application.yml.example
Normal file
@ -0,0 +1,118 @@
|
||||
server: # REST and WS server
|
||||
port: 2333
|
||||
address: localhost
|
||||
http2:
|
||||
enabled: false # Whether to enable HTTP/2 support
|
||||
|
||||
plugins:
|
||||
lavasrc:
|
||||
providers: # Custom providers for track loading. This is the default
|
||||
- "ytsearch:\"%ISRC%\"" # Will be ignored if track does not have an ISRC. See https://en.wikipedia.org/wiki/International_Standard_Recording_Code
|
||||
- "ytsearch:%QUERY%" # Will be used if track has no ISRC or no track could be found for the ISRC
|
||||
- "spsearch:%QUERY%"
|
||||
- "scsearch:\"%ISRC%\""
|
||||
- "scsearch:%QUERY%"
|
||||
- "dzisrc:\"%ISRC%\""
|
||||
- "dzsearch:%QUERY%"
|
||||
sources:
|
||||
spotify: true # Enable Spotify source
|
||||
applemusic: false # Enable Apple Music source
|
||||
deezer: true # Enable Deezer source
|
||||
yandexmusic: false # Enable Yandex Music source
|
||||
flowerytts: false # Enable Flowery TTS source
|
||||
youtube: true # Enable YouTube search source (https://github.com/topi314/LavaSearch)
|
||||
spotify:
|
||||
clientId: ""
|
||||
clientSecret: ""
|
||||
countryCode: "US" # the country code you want to use for filtering the artists top tracks. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
|
||||
playlistLoadLimit: 6 # The number of pages at 100 tracks each
|
||||
albumLoadLimit: 6 # The number of pages at 50 tracks each
|
||||
deezer:
|
||||
masterDecryptionKey: "" # the master key used for decrypting the deezer tracks. (yes this is not here you need to get it from somewhere else)
|
||||
|
||||
lavalink:
|
||||
plugins:
|
||||
- dependency: "com.github.topi314.lavasrc:lavasrc-plugin:4.0.1"
|
||||
repository: "https://maven.lavalink.dev/releases" # this is optional for lavalink v4.0.0-beta.5 or greater
|
||||
snapshot: false # set to true if you want to use snapshot builds (see below)
|
||||
|
||||
server:
|
||||
password: "youshallnotpass"
|
||||
sources:
|
||||
youtube: true
|
||||
bandcamp: true
|
||||
soundcloud: true
|
||||
twitch: true
|
||||
vimeo: true
|
||||
http: true
|
||||
local: false
|
||||
filters: # All filters are enabled by default
|
||||
volume: true
|
||||
equalizer: true
|
||||
karaoke: true
|
||||
timescale: true
|
||||
tremolo: true
|
||||
vibrato: true
|
||||
distortion: true
|
||||
rotation: true
|
||||
channelMix: true
|
||||
lowPass: true
|
||||
|
||||
bufferDurationMs: 400 # The duration of the NAS buffer. Higher values fare better against longer GC pauses. Duration <= 0 to disable JDA-NAS. Minimum of 40ms, lower values may introduce pauses.
|
||||
frameBufferDurationMs: 5000 # How many milliseconds of audio to keep buffered
|
||||
opusEncodingQuality: 10 # Opus encoder quality. Valid values range from 0 to 10, where 10 is best quality but is the most expensive on the CPU.
|
||||
resamplingQuality: LOW # Quality of resampling operations. Valid values are LOW, MEDIUM and HIGH, where HIGH uses the most CPU.
|
||||
trackStuckThresholdMs: 10000 # The threshold for how long a track can be stuck. A track is stuck if does not return any audio data.
|
||||
useSeekGhosting: true # Seek ghosting is the effect where whilst a seek is in progress, the audio buffer is read from until empty, or until seek is ready.
|
||||
youtubePlaylistLoadLimit: 6 # Number of pages at 100 each
|
||||
playerUpdateInterval: 5 # How frequently to send player updates to clients, in seconds
|
||||
youtubeSearchEnabled: true
|
||||
soundcloudSearchEnabled: true
|
||||
gc-warnings: true
|
||||
ratelimit:
|
||||
ipBlocks: ["IPv6 Block"] # list of ip blocks
|
||||
excludedIps: [] # ips which should be explicit excluded from usage by lavalink
|
||||
strategy: "LoadBalance" # RotateOnBan | LoadBalance | NanoSwitch | RotatingNanoSwitch
|
||||
searchTriggersFail: true # Whether a search 429 should trigger marking the ip as failing
|
||||
# retryLimit: -1 # -1 = use default lavaplayer value | 0 = infinity | >0 = retry will happen this numbers times
|
||||
#youtubeConfig: # Required for avoiding all age restrictions by YouTube, some restricted videos still can be played without.
|
||||
#email: "" # Email of Google account
|
||||
#password: "" # Password of Google account
|
||||
#httpConfig: # Useful for blocking bad-actors from ip-grabbing your music node and attacking it, this way only the http proxy will be attacked
|
||||
#proxyHost: "localhost" # Hostname of the proxy, (ip or domain)
|
||||
#proxyPort: 3128 # Proxy port, 3128 is the default for squidProxy
|
||||
#proxyUser: "" # Optional user for basic authentication fields, leave blank if you don't use basic auth
|
||||
#proxyPassword: "" # Password for basic authentication
|
||||
|
||||
metrics:
|
||||
prometheus:
|
||||
enabled: false
|
||||
endpoint: /metrics
|
||||
|
||||
sentry:
|
||||
dsn: ""
|
||||
environment: ""
|
||||
# tags:
|
||||
# some_key: some_value
|
||||
# another_key: another_value
|
||||
|
||||
logging:
|
||||
file:
|
||||
path: ./logs/
|
||||
|
||||
level:
|
||||
root: INFO
|
||||
lavalink: INFO
|
||||
|
||||
request:
|
||||
enabled: true
|
||||
includeClientInfo: true
|
||||
includeHeaders: false
|
||||
includeQueryString: true
|
||||
includePayload: true
|
||||
maxPayloadLength: 10000
|
||||
|
||||
logback:
|
||||
rollingpolicy:
|
||||
max-file-size: 1GB
|
||||
max-history: 30
|
||||
8
config.ini.example
Normal file
8
config.ini.example
Normal file
@ -0,0 +1,8 @@
|
||||
[BOT_INFO]
|
||||
token =
|
||||
bot_color =
|
||||
|
||||
[LAVALINK]
|
||||
host =
|
||||
port =
|
||||
password =
|
||||
Loading…
x
Reference in New Issue
Block a user