Skip to content

DuncteBot/skybot-lavalink-plugin

Repository files navigation

DuncteBot lavalink plugin

Adding support for the following sources:

  • Mixcloud
  • ocremix.org
  • Clyp.it
  • Reddit
  • getyarn.io
  • Text To Speech (if prefixed with speak:)
  • TikTok (in beta, works on most videos and will break all the time)
  • PornHub
  • soundgasm

Lavalink version compatibility

Lavalink Version Plugin Version
3.x.x 1.4.x OR 1.5.x *
4.x.x 1.4.x, 1.5.x OR 1.6.x

* Version 1.5.x will only work on Lavalink v3 if you are running java 17 or newer

Lavaplayer users

Currently not supported

If you need to add the source managers to your lavalink instance as well you can use this library to add them: https://github.com/DuncteBot/skybot-source-managers

Adding to lavalink

Latest version: Latest version

Add the following to your lavalink configuration, make sure to replace VERSION with the latest version listed above (do not include the v).

lavalink:
    plugins:
        - dependency: "com.dunctebot:skybot-lavalink-plugin:VERSION"
          repository : "https://maven.lavalink.dev/releases" # (optional on lavalink 4)
          snapshot: false # (optional, tells lavalink to use the default snaptshot repository instead)

Alternatively you can download the jar from the release on github and place that in your plugins folder

Configuration

The plugin exposes these configuration options
NOTE: this plugins block is a root level object, don't place it where you import the plugin

plugins:
    dunctebot:
        ttsLanguage: "en-AU" # language of the TTS engine
        sources:
            # true = source enabled, false = source disabled
            getyarn: true # www.getyarn.io
            clypit: true # www.clyp.it
            tts: true # speak:Words to speak
            pornhub: true # should be self-explanatory
            reddit: true # should be self-explanatory
            ocremix: true # www.ocremix.org
            tiktok: true # tiktok.com
            mixcloud: true # mixcloud.com
            soundgasm: true # soundgasm.net

development

You can start the test server by running ./gradlew runLavalink