Paper Plugin

Server Plugin

The Music Craft server plugin coordinates shared jukebox sessions, audio synchronization, player permissions, radio streams, and local server MP3 relays. Compatible with Paper, Purpur, Spigot, and CraftBukkit.

---

Installation

1. Run Paper, Purpur, Spigot, or CraftBukkit on Minecraft 26.3 with Java 25.
2. Download MusicCraft-Paper-1.0.0.jar from Modrinth or CurseForge.
3. Put the jar into the server plugins/ directory.
4. Start the server once to generate configuration files.
5. In plugins/MusicCraft/config.yml, configure your server-id:

   config-version: 1
   server-id: my-server
   api-url: https://sonoxel-edge.sonoxel-edge.workers.dev
   radio-country: auto
   require-client-mod: false

6. Apply changes with /musiccraft admin reload or restart the server.

No additional ports are required. Server MP3 audio and radio streams are transmitted over existing player network connections.

---

Commands & Permissions

Command	Permission	Description
/musiccraft status	musiccraft.use	View active jukebox sessions and connected modded clients
/musiccraft jukebox	musiccraft.use	Opens the menu for the jukebox block in crosshairs
/musiccraft stop	musiccraft.control	Stops playback on the targeted jukebox
/musiccraft admin reload	musiccraft.admin	Reloads config.yml and refreshes the local music directory

---

Local MP3 Audio

To add custom music:

1. Place .mp3 files in plugins/MusicCraft/music/.
2. Name files Artist - Track Name.mp3 for automatic title and artist tagging.
3. For custom attribution metadata, create a companion JSON file (for example song.json next to song.mp3):

   {
     "title": "My Track",
     "artist": "Artist Name",
     "credit": "Used with permission"
   }

4. Run /musiccraft admin reload. Indexed tracks appear under the Server tab in the player menu.

---

Live Internet Radio

Setting radio-country: auto queries stations corresponding to the server host location.

To fix stations to a specific region, configure a 2-letter ISO country code in config.yml (for example US, GB, IN, DE, CA, JP). Players can also switch between local and global stations in the radio tab.

---

Client Requirements

By default (require-client-mod: false), players without the Fabric mod can connect and play normally. If you want to enforce mod installation on join, set require-client-mod: true in config.yml.