Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
topi314 committed May 5, 2024
1 parent 9b88fb9 commit 8b3dce4
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 13 deletions.
3 changes: 2 additions & 1 deletion LavalinkServer/application.yml.example
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ lavalink:
server:
password: "youshallnotpass"
sources:
youtube: true
# The default Youtube source is now deprecated and won't receive further updates. Please use https://github.com/lavalink-devs/youtube-source#plugin instead.
youtube: false
bandcamp: true
soundcloud: true
twitch: true
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ A [basic example bot](Testbot) is available.
## Features
* Powered by Lavaplayer
* Minimal CPU/memory footprint
* Twitch/YouTube stream support
* Twitch/YouTube (via [this](https://github.com/lavalink-devs/youtube-source#plugin) plugin) stream support
* Event system
* Seeking
* Volume control
Expand Down
23 changes: 12 additions & 11 deletions docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,17 @@ Lavalink loads all .jar files placed in the `plugins` directory, which you may n
also download plugin .jar files automatically by editing the configuration file. See the respective plugin repository
for instructions.

| Plugin | Description |
|---------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| [Google Cloud TTS plugin](https://github.com/DuncteBot/tts-plugin) | A text to speech plugin using the [google cloud tts api](https://cloud.google.com/text-to-speech/docs) |
| [SponsorBlock plugin](https://github.com/topi314/Sponsorblock-Plugin) | Skip sponsor segments in YouTube videos & return YouTube video chapter information |
| [LavaSrc plugin](https://github.com/topi314/LavaSrc) | Spotify, Apple Music & Deezer(native play) support |
| [LavaSearch plugin](https://github.com/topi314/LavaSearch) | Advanced search functionality including playlists, albums, artists, tracks & terms |
| [DuncteBot plugin](https://github.com/DuncteBot/skybot-lavalink-plugin) | Additional source managers that are not widely used |
| [XM plugin](https://github.com/esmBot/lava-xm-plugin) | Support for various [music tracker module](https://en.wikipedia.org/wiki/Module_file) formats |
| [Lyrics.kt plugin](https://github.com/DRSchlaubi/lyrics.kt) | Plugin that fetches timestamped lyrics from YouTube |
| [Java Timed Lyrics](https://github.com/DuncteBot/java-timed-lyrics) | Timestamped lyrics from YouTube with Genius fallback, supports IP-rotation |
| [LavaDSPX Audio Filters](https://github.com/Devoxin/LavaDSPX-Plugin) | Additional audio filters for Lavalink |
| Plugin | Description |
|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| [YouTube Plugin](https://github.com/lavalink-devs/youtube-source#plugin) | YouTube source plugin for Lavalink |
| [Google Cloud TTS plugin](https://github.com/DuncteBot/tts-plugin) | A text to speech plugin using the [google cloud tts api](https://cloud.google.com/text-to-speech/docs) |
| [SponsorBlock plugin](https://github.com/topi314/Sponsorblock-Plugin) | Skip sponsor segments in YouTube videos & return YouTube video chapter information |
| [LavaSrc plugin](https://github.com/topi314/LavaSrc) | Spotify, Apple Music & Deezer(native play) support |
| [LavaSearch plugin](https://github.com/topi314/LavaSearch) | Advanced search functionality including playlists, albums, artists, tracks & terms |
| [DuncteBot plugin](https://github.com/DuncteBot/skybot-lavalink-plugin) | Additional source managers that are not widely used |
| [XM plugin](https://github.com/esmBot/lava-xm-plugin) | Support for various [music tracker module](https://en.wikipedia.org/wiki/Module_file) formats |
| [Lyrics.kt plugin](https://github.com/DRSchlaubi/lyrics.kt) | Plugin that fetches timestamped lyrics from YouTube |
| [Java Timed Lyrics](https://github.com/DuncteBot/java-timed-lyrics) | Timestamped lyrics from YouTube with Genius fallback, supports IP-rotation |
| [LavaDSPX Audio Filters](https://github.com/Devoxin/LavaDSPX-Plugin) | Additional audio filters for Lavalink |

If you want to make your own plugin see [here](api/plugins.md)

0 comments on commit 8b3dce4

Please sign in to comment.