Minecraft plugin NoteBlockAPI

🔌 About NoteBlockAPI

NoteBlockAPI — is a Minecraft plugin/library that allows playback of .nbs note‑block songs and exposes an API plugins can use to play NBS audio on a Paper/Spigot Minecraft server.

🎯 Purpose

NoteBlockAPI provides a lightweight, thread‑aware API to play .nbs songs created with OpenNoteBlockStudio (or converted from MIDI). It solves the problem of other plugins needing reliable noteblock audio playback without bundling decoding code or resource packs. NoteBlockAPI is intended for server-side use by plugin developers and server administrators who want in‑game music playback via .nbs files.

⚙ Main features

• Play .nbs files as noteblock sounds from plugins (Song playback API).
• Support for custom instruments via resource‑packs (optional) and extended octave ranges when resource packs are provided.
• Multithreaded playback to reduce main‑thread load where possible.
• Ability to handle timings not achievable with vanilla redstone. ()

🧩 Who is it for

• Plugin developers who need an API to play NBS songs.
• Server administrators running Paper/Spigot who want in‑game music without client mods.
• Servers using NoteBlockMusicPlayer or other plugins that rely on NoteBlockAPI.

🏗 Examples of use

• A lobby plugin plays a playlist of .nbs songs when players enter a region.
• A minigame uses note‑block songs for round intros and ambience via NoteBlockAPI calls.
• A custom radio system (e.g., NoteBlockMusicPlayer) uses NoteBlockAPI to stream songs to players. ()

⚡ Notable technical details

• Tested on multiple Minecraft server versions up to several recent versions (Spigot listing shows testing across 1.8 → 1.21 ranges; see official page and releases for exact supported builds and the latest release). ()
• Latest official release: v1.6.3 (released Nov 11, 2024). ()

⌨️ Commands

🔐 Permissions

⚙ Installation

📥 Installation

• Download the NoteBlockAPI .jar from the official release (Spigot/Modrinth/GitHub releases).
• Place the .jar into your server's plugins/ folder.
• Fully restart the server (do not use /reload).
• Install any plugin that uses NoteBlockAPI and place its .nbs files in the appropriate plugin folder (see that plugin's docs). ()

📦 Dependencies

• No mandatory plugin dependencies listed. NoteBlockAPI is a library; it does not require Vault/PlaceholderAPI etc. Optional: resource‑packs for custom instruments and extended octaves. Do not assume other dependencies unless documented by the using plugin. ()

🧾 Configuration

• Official documentation does not show a global config.yml for NoteBlockAPI in the public resource page. If a config exists, it is documented in the GitHub wiki or release notes. Check the repository Wiki / releases for details. ()
• Database support (MySQL/SQLite): Not applicable — NoteBlockAPI is an audio playback library and does not document database support in official sources.

🧠 Additional information

Known limitations & conflicts

• Some users reported performance issues for very fast/complex melodies; fast tempos can be CPU‑intensive and may lag on some server setups (reports visible in reviews). This is a known limitation tied to scheduler and playback timing, and the author has indicated improvements planned. ()
• As with any library that plays sounds, compatibility depends on server core (Spigot/Paper) and other plugins that hook into scheduler or audio systems.

FAQ

Q: Does NoteBlockAPI add player commands to control playback? A: No — NoteBlockAPI is a library. Playback commands are provided by plugins that use the API (for example NoteBlockMusicPlayer). ()

Q: Does the plugin collect usage statistics (bStats)? A: There is a bStats entry for NoteBlockAPI, indicating a bStats plugin id exists; check the GitHub/Spigot release notes or plugin jar for current telemetry behavior. (Inference from public bStats listing.) ()

Q: Where is documentation and source? A: Source and releases: GitHub repository; documentation and examples are on the repository Wiki and the Spigot resource page. Use GitHub issues for bug reports. ()

Q: Is Discord support available? A: The author links a Discord server on the Spigot resource page for support. ()

When to use NoteBlockAPI

Use NoteBlockAPI when you need a proven, lightweight Java API to play .nbs songs from server‑side plugins on Paper/Spigot-based Minecraft servers. It is a library rather than an end‑user music plugin; for ready‑to‑use players consider NoteBlockMusicPlayer which depends on NoteBlockAPI. ()

Keywords present (for SEO/context): NoteBlockAPI, minecraft plugin, spigot plugin, paper plugin, minecraft server, plugin commands, plugin permissions, NBS, music, library.