CustomDiscs SVC

[!(https://img.shields.io/modrinth/dt/1yowwDpk?logo=modrinth&label=downloads)](https://modrinth.com/plugin/customdiscs-svc)

# CustomDiscs

CustomDiscs brings custom, positional music discs to Minecraft servers through (https://modrinth.com/plugin/simple-voice-chat). Turn a regular music disc into a custom one backed by a local MP3, WAV, or FLAC file, or stream a track from a supported remote service such as YouTube or SoundCloud.

Audio is played from the jukebox position, so players hear it naturally as they move through the world. Server owners can control playback range, volume, track limits, disc appearance, visualizations, and remote provider behavior. Developers can integrate with playback through the public API and Bukkit events.

## Special thanks

CustomDiscs builds on ideas and technology from these projects:

• (https://github.com/Navoei/CustomDiscs)
• (https://github.com/henkelmax/audio-player)
• (https://github.com/sedmelluq/lavaplayer)

• (https://modrinth.com/plugin/customdiscs-svc)
• (https://github.com/Idiots-Foundation/CustomDiscs-SVC)
• (#developer-api)
• (https://repo.subkek.space/maven-public/)
• (https://discord.gg/eRvwvmEXWz)

## Features

• Local playback from MP3, WAV, and FLAC files
• Remote playback from YouTube and SoundCloud URLs
• Positional audio powered by Simple Voice Chat
• Per-jukebox playback radius
• Custom model data for local and remote discs
• Configurable particles and playback holograms
• Configurable maximum file size and track duration
• English and Russian translations
• Folia-aware scheduling
• Public API, lifecycle events, and audio packet handlers

## Requirements

CustomDiscs requires the following server plugins:

• (https://modrinth.com/plugin/simple-voice-chat)
• (https://modrinth.com/plugin/packetevents)

Players also need the Simple Voice Chat client mod to hear custom disc audio.

## Installation

1. Install Simple Voice Chat and PacketEvents on the server. 2. Download CustomDiscs from (https://modrinth.com/plugin/customdiscs-svc/versions). 3. Place all three plugin files in the server's `plugins` directory. 4. Start or restart the server. 5. Review the generated configuration in `plugins/CustomDiscs/config.yml`. 6. Make sure Simple Voice Chat is configured and working before testing a disc.

## Creating a disc

Custom discs are created from an ordinary Minecraft music disc held in the player's main hand. Arguments containing spaces must be enclosed in double quotes.

### From a local file

Place an MP3, WAV, or FLAC file in `plugins/CustomDiscs/musicdata`, or download one from a direct HTTP(S) URL:

```text /cd download "https://example.com/music/track.mp3" track.mp3 ```

Hold a music disc and convert it:

```text /cd create local track.mp3 "Track name" ```

### From a remote service

Hold a music disc and provide a supported URL:

```text /cd create remote "https://www.youtube.com/watch?v=..." "Track name" ```

Insert the resulting disc into a jukebox to start positional playback.

> [!WARNING] > Remote services commonly require additional configuration before playback will work reliably. YouTube may require OAuth2, > a PO token, a remote cipher server, or an HTTP(S) proxy. Provider behavior can change independently of CustomDiscs. Use a > secondary account for OAuth2 authorization and never publish provider credentials or tokens.

Only stream or download audio that you are authorized to use. Server owners are responsible for complying with the terms of the source service and applicable copyright law.

## Commands

The full command is `/customdiscs`; `/cd` is available as a shorter alias.

| Command | Description | Permission | |---------------------------------------------|-------------------------------------------------------------------------|-----------------------------| | `/cd` | Root CustomdDiscs command | `customdiscs` | | `/cd help` | Shows the commands available to the sender. | `customdiscs.help` | | `/cd reload` | Reloads configuration and language files. | `customdiscs.reload` | | `/cd download "" ` | Downloads an MP3, WAV, or FLAC file into `musicdata`. | `customdiscs.download` | | `/cd create local ""` | Converts the held music disc using a local file. | `customdiscs.create.local` | | `/cd create remote "" ""` | Converts the held music disc using a supported remot