API reference

These pages are generated from the Javadoc on the public API sources, so they always match the code in the repository. The prose guides explain how to use the APIs: Spatial audio API for servers and addons, and Proxy addon API for Velocity / BungeeCord relay addons.

Every release publishes these APIs as interface-only jars, served as Maven coordinates, so an addon names a version instead of vendoring a jar. Always compileOnly — SocketSVC supplies the classes at runtime, and shading them puts a second copy of the interfaces on the classpath.

repositories {
    maven("https://socketsvc-updater.vercel.app/maven") {
        name = "SocketSVC"
        // Nothing else is published there, so no other lookup is slowed down by it.
        content { includeGroup("com.socketsvc") }
    }
}

Shared types複製段落連結

Speaker, position and audio-source types in com.socketsvc.api. They are shared by the Paper plugin and the server mods, so addon logic written against them ports between the two unchanged.

Included in both server-side API jars below; there is no separate coordinate for them.

Paper plugin API複製段落連結

The entry point for Bukkit/Paper plugins. Obtain it from the Bukkit ServicesManager, compile against the API JAR with compileOnly, and never shade it.

compileOnly("com.socketsvc:socketsvc-server-paper-api:0.2.5")

Server mod API複製段落連結

The Fabric/NeoForge/Forge equivalent of the Paper API, identifying callers by mod id.

compileOnly("com.socketsvc:socketsvc-server-mod-api:0.2.5")

Client API複製段落連結

Cross-mod client-side contract: query voice state and play sounds only the local player hears. Channels created here are local-only and never reach the voice connection.

compileOnly("com.socketsvc:socketsvc-client-api:0.2.5-mc26.3")

This is the one API jar built per Minecraft version — SocketSvcClientApi takes a net.minecraft Entity — so the version names the game version it was built against, and there is one for every supported version. Its classes carry Minecraft's official (Mojang) names, which is what NeoForge and Forge compile against; a Fabric mod on Yarn mappings needs a remap step.

Proxy API複製段落連結

Routing and observation for the Velocity / BungeeCord relay: which backend a player is relayed to, and what the relay is doing. The relay never decodes audio, so nothing about speakers, positions or volume lives here — that is the server-side spatial audio API.

compileOnly("com.socketsvc:socketsvc-proxy-api:0.2.5")