Musicv0.2.1
Pythonby TheNINJALLOPlays custom music through album discs and jukeboxes, with playlists for the whole server.
pip install https://github.com/TheNINJALLO/endstone-music/releases/download/v0.2.1/endstone_music-0.2.1-py3-none-any.whl- Stars
- 2
PLUGINSMUSIC
# Install
Use the animation for reference. Follow the plugin's README for exact steps.
# README
Overview
Music 0.2.1 adds single-track and album discs, configurable jukeboxes, operator global playlists and generated audio/resource packs.
Follow Player is on by default: once a nearby listener hears a disc, the remaining track or album stays with them as they move away. The initial radius controls admission; it does not send that album to unrelated distant players. Global playlists intentionally play to everyone.
What it does
- Insert, eject, skip/restart and recover persistent single-track or album discs.
- Set per-block presets for radius, volume, pitch and optional positional fading.
- Edit ordered global playlists and use generated custom playlist items/jukebox blocks.
- Convert OGG, MP3 and WAV uploads into streamed stereo and mono assets in a background worker.
- Keep one plugin-owned voice per listener and use the scoped protocol-2225 adapter for current-position playback.
- Retain uploads, existing pack identities and unrelated pack entries during generation.
How to use
- Install the wheel, then start the server once to create the Music data folder.
- Install FFmpeg and ffprobe on PATH. Set
target_world_nameinplugins/music/config.jsonto the actual world folder. - Put audio in
plugins/music/uploads/, run/cmusic generate, and wait for completion. - Restart the server and reconnect clients, accepting the generated resource pack. Generation installs both the resource and behavior packs.
- Open
/cmusic> Albums & Discs, create a disc with one generated track ID or an ordered list, then select it to receive the item. - Right-click a vanilla jukebox with that disc. Normal right-click ejects; sneak-right-click skips or restarts. Leave an empty inventory slot for ejection.
- For server-wide music, use Global Playlists instead. Generate again after adding a global playlist if you want its custom playlist item, then restart/reconnect.
Follow the complete how-to for no-fade playback, custom block setup, triggers, login audio, global playlists, configuration and troubleshooting. Existing servers upgrading from 0.2.0 should regenerate the packs and restart/reconnect.
Commands and permissions
Management requires endstone_music.command.cmusic (operator by default). Ordinary players can use configured insertable discs on accepted blocks. Global playlist controls require music operator permission.
| Command | Purpose |
|---|---|
/cmusic | Open the operator menu |
/cmusic status | Runtime, adapter counters, track/disc counts and global playback |
/cmusic generate or /cmusic migrate | Generate and activate the selected world's resource/behavior packs |
/cmusic reload | Validate config/playlists, stop global audio and restart stored-disc playlists |
/cmusic give <disc-id> [player name] | Give an insertable single/album disc to an online player |
/cmusic bind <preset-id> | Assign a preset on the next matching block click |
/cmusic recover | Open stored-disc recovery |
/cmusic playlists | Manage global playlists |
/cmusic play <playlist-id> | Play a global playlist for everyone |
/cmusic next | Advance the global playlist |
/cmusic stop | Stop all plugin-owned music; keep inserted discs recoverable |
/cmusic give jukebox | Give the generated custom jukebox block in-game |
/cmusic give <playlist-id> | Give a generated global playlist item in-game |
/cmusic playlist ... | Create, add, remove, move, loop or delete a global playlist |
The full command reference includes playlist editing syntax. Keep global playlist and insertable-disc IDs distinct; reserve jukebox for the generated block.
Compatibility
| Component | Target |
|---|---|
| Plugin | 0.2.1 |
| Endstone / API | 0.11.15 / 0.11 |
| BDS / runtime / protocol | 1.26.60.6 / 26.60 / 2225 |
| Server platform | Linux x86-64 |
| Python | >=3.11 |
| Audio tools | Installed ffmpeg and ffprobe |
Playback is gated to the reviewed runtime combination. Unsupported runtimes keep administration and stored-disc recovery available, but disable new playback. The plugin does not download converter executables.
All 97 automated tests passed in Linux CI, including native API contracts, packet layout, audio conversion, playback, item persistence, migration and custom content. Official Linux/Windows server binaries were verified. Live Linux server integration and audible Bedrock-client playback remain unverified; follow the acceptance checklist.
Install
Download the wheel from Music v0.2.1:
gh release download v0.2.1 --repo TheNINJALLO/endstone-music --pattern '*.whl'Stop the server, back up the world and Music data, replace the older Music wheel in plugins/, and restart. See installation, upgrade and rollback. The optional setup ZIP contains the wheel and the documentation snapshot from release time; current guides are maintained in this repository.
Configuration and data
The active data folder is normally plugins/music/. config.json holds insertable albums/discs, triggers, join settings and jukebox presets. playlists.json holds operator global playlists and custom-block links; jukeboxes.json holds the exact inserted items. Retain these files, uploads/, pack_metadata.json and the installed world packs together when backing up or migrating.
Use the configuration example as a schema reference. Its sample durations are placeholders: use measured generated durations or the real duration of external sound events. Merge your settings rather than replacing a live config with the example.
Custom inserted discs use plugin storage rather than the vanilla record slot; hopper/comparator automation is not included. The built-in global custom block/items are generated by the plugin; additional artwork and arbitrary custom block/item IDs must be registered by installed packs.
Verification and release automation
- Full how-to and troubleshooting
- Install and rollback
- Native API and protocol adapter
- Validation record and server/client acceptance
- Exact BDS identities
After installing the project and audio tools, run python run_tests.py. The release workflow reruns the suites on Linux, builds the wheel/setup bundle and uploads artifacts. A new package version on main, or a matching v* tag, publishes its release; branch builds leave existing releases unchanged.
Not an official Minecraft product. Not approved by or associated with Mojang or Microsoft.
Not an official Minecraft product. Not approved by or associated with Mojang or Microsoft.