RegionBGM API

Region BGM API

This mod can be used by others mods as an API in order to stream background music to players, from different sources (youtube, twitch, almost anything).

It can be used in different ways. For example, defining zones with a background music.

The mod use the lavaplayer libray from sedmelluq !

Currently the mod is made for 1.12.2.

Mods using the API

The RegionBGM mod is useless alone, it requires to have another mod installed to be able to exploit it.

Usually, you need to install RegionBGM on client-side and on server-side, and the mod exploiting it on server-side.

For now, here’s the list of the mods using RegionBGM :

• Zone BGM : A mod using Forge Essentials and RegionBGM in order to define zones where music can be played. It adds immersion in different zones of your server (city, pirate ships, etc…). The mod is required on server-side only.

I hope more mods will come later!

Configuration

You can edit two parameters in the mod’s configuration GUI :

• enabled : Enables or disables the mod.
• volume: Set the background music volume.

In-game, each mod using the RegionBGM API is associated to a gamerule bgm_modid which is set to true by default. If this rule is set on false, the mod using the RegionBGM API will be "disabled" (won’t be able to send packets to clients and triggers musics).

Supported sources

The music can be a source from internet : A youtube video, a youtube playlist, a twitch livestream…

As the the mod uses lavaplayer you can check all the supported sources here.

Developers

For more information about how to use the API into your own mod, check the github repository of RegionBGM

Logo

Logo made by Freepik from www.flaticon.com.