Region BGM API

This mod serves as a programming interface that other modifications can use to play background music in the game. It supports streaming audio from various online sources, including YouTube, Twitch, and many other platforms.

The primary application of the API is creating zones with unique musical accompaniment. This allows developers to add atmospheric soundtracks in specific areas of the game world, significantly enhancing the immersion level.

The technical foundation of the mod is the lavaplayer library created by developer sedmelluq. Currently, the project supports Minecraft version 1.12.2.

Mods Using the API

By itself, RegionBGM has no functionality - its operation requires the installation of additional modifications that implement specific features.

The typical installation scheme involves placing RegionBGM on both client and server, while the extension mod is installed only on the server side.

Currently available projects using this API include:

• Zone BGM: A modification that integrates with Forge Essentials and RegionBGM to create musical zones. Perfect for adding unique soundtracks in various server locations - cities, pirate ships, and other thematic areas. Requires installation only on the server.

Configuration

Users can adjust two main parameters through the configuration interface:

• enabled: Enabling or disabling mod functionality
• volume: Adjusting background music volume

During gameplay, for each mod using RegionBGM API, a special game rule bgm_modid is created, which is active by default. When this rule is disabled, the corresponding modification stops sending packets to clients and activating musical accompaniment.

Supported Sources

The system supports a wide range of online audio sources: individual YouTube videos, YouTube playlists, Twitch live streams, and much more.

Thanks to the use of the lavaplayer library, the complete list of supported formats and platforms corresponding to this technology's capabilities is available.

For Developers

Developers wishing to integrate RegionBGM API into their projects can find detailed technical documentation and usage examples in the corresponding GitHub repository.