NoteBox

A powerful Minecraft Spigot/Paper music plugin that plays NBS (Note Block Studio) format songs with a built-in audio engine -- no external dependencies required.

---

Features

• NBS Song Playback - Play Note Block Studio format music files seamlessly
• Radio Mode - Listen privately (only you can hear)
• Speaker Mode - Broadcast music to nearby players
• Music Signs - Redstone-triggered music playback
• Jukebox Integration - Right-click jukeboxes to open the music GUI
• GUI Browser - Intuitive graphical interface for browsing songs
• Playlists - Create and manage personal playlists
• Disc Shop - Economy-powered music disc store (Vault support)
• Song Search - Search songs by keyword
• Song Request - Request songs with configurable cooldown
• Volume Control - Per-player volume adjustment (0-100)
• Loop Modes - None, Single, All, Shuffle
• Particle Effects - Visual effects synchronized with music
• Region Music - Auto-play music in WorldGuard regions
• PlaceholderAPI - Placeholder support for other plugins
• Multi-language - Chinese, English, Russian
• Permission System - Granular permission control
• Self-contained - Built-in NBS parser and sequencer, no NoteBlockAPI needed

Commands

Command	Description	Permission
/notebox	Open the music GUI	notebox.use
/notebox play <song>	Play a song	notebox.use
/notebox silent [player]	Toggle silent mode	notebox.use
/notebox stop	Stop current playback	notebox.use
/notebox next	Skip to next song	notebox.use
/notebox volume <0-100>	Set personal volume	notebox.use
/notebox loop	Cycle loop mode	notebox.use
/notebox search <query>	Search songs	notebox.use
/notebox request <song>	Request a song	notebox.request
/notebox particles	Toggle particle effects	notebox.use
/notebox shop [player]	Open disc shop	notebox.shop
/notebox playlist	Manage playlists	notebox.use
/notebox give <player> <song>	Give a music disc	notebox.get
/notebox give_single <player> <song>	Give a single disc	notebox.get
/notebox reload	Reload configuration	notebox.admin
/notebox shutup	Stop all music	notebox.admin

Permissions

Permission	Description	Default
notebox.use	Use /notebox command	All players
notebox.speaker	Use speaker mode	All players
notebox.shop	Access disc shop	All players
notebox.shop.other	Open shop for others	Operators
notebox.get	Get any music disc	Operators
notebox.request	Use song request	All players
notebox.sign	Create music signs	All players
notebox.silent.other	Change others' silent mode	Operators
notebox.hear	Hear music (when check enabled)	All players
notebox.admin	Reload and manage music	Operators

Installation

1. Download NoteBox-x.x.x.jar from the Releases page.
2. Place the JAR file in your server's plugins/ directory.
3. Restart your server or run /reload confirm.
4. Place NBS song files in plugins/NoteBox/songs/.
5. Run /notebox reload to load all songs.
6. Use /notebox to start listening.

Configuration

See Configuration Reference for the full configuration guide.

Building from Source

git clone https://github.com/ALingqing/NoteBox.git
cd NoteBox
./gradlew build

The compiled JAR will be at build/libs/NoteBox-1.0.0.jar.

API for Addon Developers

NoteBox provides a public API for plugin developers. Add NoteBox as a dependency to create addons and extensions.

NoteBoxAPI api = NoteBoxAPI.getInstance();
api.playSong(player, "my_song");

See the Addon Development Guide for detailed documentation and examples.

Dependencies

Dependency	Type	Required
Spigot/Paper 1.13+	API	Yes
Vault	Plugin	No (economy)
PlaceholderAPI	Plugin	No (placeholders)
WorldGuard	Plugin	No (region music)

Technical Details

NoteBox includes a complete NBS file parser and sequencing engine based on the NoteBlockAPI architecture, integrated directly into the plugin. No additional NoteBlockAPI installation is needed.

Documentation

• Wiki - User documentation and guides
• Addon Development - API guide for developers
• API Reference - Complete API documentation
• Configuration - Configuration reference

License

This project is licensed under the terms specified in the LICENSE file.

Author

ALingqing_ - Plugin development and maintenance

本项目基于 MusicBox 和 NoteBlockAPI 的功能重制，仅供学习参考。