Skip to content

Configuration

valk edited this page Oct 2, 2026 · 2 revisions

Four files in plugins/CDisc/, split on purpose: three are safe to share, one is not.

File Holds Share it?
config.yml How the plugin behaves yes
sources.yml Which services it may play from yes
permissions.yml Who may do what. See Permissions yes
tokens.yml Keys, tokens and passwords never

Every setting has a comment beside it in the file, and those comments are kept current with each release. This page is a map of where things are.

Applying changes

  • /cdisc admin reload re-reads all four files and registers the sources again.
  • /cdisc admin config edits all four in a dialog window, one tab per file, and reloads on save. Paper 1.21.7+ only, operators only (cdisc.admin.config). config-dialog: false in config.yml turns the window off.

Upgrades

On every start, each file is rebuilt from the copy inside the jar:

  • the order of keys and every comment come from the new copy;
  • each value you changed by hand is kept;
  • new settings arrive with their defaults;
  • settings that no longer exist are dropped and named in the console;
  • the previous file is kept beside it as <name>.old;
  • if the merge can't be read back cleanly, the file is left untouched.

So there is nothing to do by hand after an update.

config.yml

Section What it is
language auto or a fixed language. See Languages
voice-backend, svc-config, pv-config Voice plugin choice, base hearing range, category names. See Installation
beacon-range-boost See Portable jukebox and range
volume Default jukebox volume, in percent
crossfade Seconds of blend between queued discs. See Player screen
broadcast See Broadcasts
sound-anchor, portable-jukebox See Portable jukebox and range
worldguard See Integrations and API
goat-horn See Creating discs
speaker-group See Speaker groups
lyrics Server defaults for the hologram. See Lyrics and holograms
resume-playback Restart playing jukeboxes after a restart
sneak-mode Default crouch behaviour: toggle, release, off
player-dialog, player-dialog-refresh-ticks Player screen as a dialog on 1.21.6+
config-dialog The settings window
log-upload /cdisc admin logs on or off for everyone
update-checker Checks, notifications, and automatic install on shutdown
metrics Anonymous bStats: server-level counts only. No player names, UUIDs, IPs, tracks or searches
debug Names the path each track came from in the console

sources.yml

Section What it is
proxy An outgoing HTTP proxy for every request
enabled Each source on or off
search Result counts
local The music folder and downloads. See Local music folder
soundcloud, yandex-music, vk-music Backend addresses for those services
youtube See YouTube

See Sources for what each service needs.

tokens.yml

Everything here is optional. An empty value means "not configured"; a source that truly needs its key is then skipped at startup and named in the console.

Key For
spotify.client-id, client-secret Spotify search on Spotify itself
yandex-music.access-token Fallback when the backend can't be reached
vk-music.user-token Same, for VK
youtube.po-token, visitor-data A YouTube po-token pair. See YouTube
po-token-backend.url, password Your own token server
remote-cipher-server.password The cipher server named in sources.yml
proxy.username, password Login for the outgoing proxy

Never attach tokens.yml to an issue, a backup you give away, or a commit. /cdisc admin logs hides keys and tokens before uploading.

Clone this wiki locally