soundy

A SoundCloud source plugin for Lavalink built on lavaplayer.

Table of Contents

• Plugin
• Common
• Configuration
• Usage

---

Plugin

Drop the jar into your Lavalink plugins/ folder.

lavalink/
└── plugins/
    └── soundy-plugin-1.0.0.jar

Then declare it in your application.yml:

lavalink:
  plugins:
    - dependency: "com.waris4ly.soundy:plugin:1.0.0"
      repository: "https://maven.lavalink.dev/releases"

Or if you are loading it manually from the folder, just add the config block:

plugins:
  soundy:
    enabled: true

---

Common

The common module can be used standalone with any Lavaplayer setup outside of Lavalink.

repositories {
    maven("https://maven.lavalink.dev/releases")
}

dependencies {
    implementation("com.waris4ly.soundy:common:1.0.0")
}

Example usage:

HttpClient http = HttpClient.newBuilder()
        .followRedirects(HttpClient.Redirect.NORMAL)
        .build();

ClientIdProvider clientIdProvider = new ClientIdProvider(http);
SoundCloudHttpClient scClient = new SoundCloudHttpClient(http, clientIdProvider);
SoundCloudService service = new SoundCloudService(scClient);

// register with lavaplayer
AudioPlayerManager manager = new DefaultAudioPlayerManager();
manager.registerSourceManager(new SoundySourceManager());

---

Configuration

plugins:
  soundy:
    enabled: true  # set to false to disable the plugin without removing the jar

---

Usage

Play by URL

https://soundcloud.com/alanwalker/faded-slushii-remix-1

Search

scsearch:alan walker faded

Returns up to 10 tracks as a search playlist.

Playlist

https://soundcloud.com/someuser/sets/some-playlist

---

Build from source

./gradlew build

Output:

plugin/build/libs/soundy-plugin-1.0.0.jar