Back to mods
RegionBGM API project artwork

CurseForge · Minecraft mod

RegionBGM API

An API used y others mods to stream background music in Minecraft

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which RegionBGM API release matches 1.12.2 Forge?

Updated 5 years ago
Best match for your filters regionbgm-1.12.2-1.0.0.jar
Game version 1.12.2
Loader Forge

RegionBGM API regionbgm-1.12.2-1.0.0.jar targets 1.12.2 with Forge. The project page does not say whether this file belongs on the client, dedicated server, or both. No extra mods listed for this file.

Where it goes

Is RegionBGM API required on the client, server, or both?

The project page does not say whether this file belongs on the client, dedicated server, or both.

Client Source doesn’t say
Dedicated server Source doesn’t say
Loader for this release Forge
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

The source does not explicitly classify this release as client-only or server-only.

What else does RegionBGM API regionbgm-1.12.2-1.0.0.jar need?

regionbgm-1.12.2-1.0.0.jar on 1.12.2 Forge. Every mod below is checked against that same setup.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add RegionBGM API without breaking your instance.

Built for RegionBGM API regionbgm-1.12.2-1.0.0.jar on 1.12.2 Forge. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use regionbgm-1.12.2-1.0.0.jar. It targets 1.12.2 with Forge; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    The project page does not say whether this file belongs on the client, dedicated server, or both.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside regionbgm-1.12.2-1.0.0.jar. It opens that exact file at the source.

About this project

What does RegionBGM API add?

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.

Project description from CurseForge.

Pick your setup

RegionBGM API by Minecraft version and loader

Choose the version and loader you play, then open the matching release.

1 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

RegionBGM API versions and loaders

1 of 1 releases match

Looking for an older file? The official CurseForge project page is in Resources.