Skip to content

Server Admin Guide

B1progame edited this page Jun 2, 2026 · 2 revisions

Server Admin Guide

Important Server Files

Default storage locations:

<world>/music-import/
<world>/music-normalized/
<world>/data/musicxcst/music-index.json

music-index.json stores ownership, file metadata, checksums, status, color, and creation timestamps. Do not edit it while the server is running.

Important Config Keys

maxFileSizeBytes
maxStoragePerPlayerBytes
maxTotalServerStorageBytes
allowedFileExtensions
ffmpegMode
ffmpegPath
allowServerSideTranscoding
audioBitrate
sampleRate
maxMusicDurationEnabled
maxMusicDurationSeconds
maxMusicFilesPerPlayerEnabled
maxMusicFilesPerPlayer
playerLimitMode
clientUploadBytesPerSecond
playbackRadiusBlocks
clientCacheSizeBytes
allowSingleplayerAbsolutePaths
allowAdminAbsoluteServerPaths
softDeleteEnabled
allowFoundDiscsPlayback
ownerOnlyPlayback
adminBypass

Duration Limits

Duration examples:

150 seconds  = 2:30
600 seconds  = 10:00
3600 seconds = 1:00:00

Set maxMusicDurationEnabled to false for no duration limit.

Per-Player File Limits

playerLimitMode accepts:

confirm_delete_oldest
auto_delete_oldest
block_new_upload

When deleting an oldest upload, MusicXCST only targets entries owned by that player. It updates metadata and removes stored audio files for that entry.

Public Server Recommendations

  • Enable size, duration, and per-player file limits.
  • Keep allowAdminAbsoluteServerPaths disabled unless all admins are trusted.
  • Use block_new_upload or confirm_delete_oldest for stricter moderation.
  • Back up the music index and audio folders before major updates.
  • Publish clear rules about uploaded audio rights.

Clone this wiki locally