Skip to content

Overview of the API

rocamocha edited this page Oct 1, 2025 · 5 revisions

Importing the API package gives you access to important classes and interfaces you'll need to start developing a Reactive Music plugin, or to hook into some of Reactive Music's core features as a mod developer.

import circuitlord.reactivemusic.api;

This class is the main entrypoint for Reactive Music developers. You'll find many useful methods and object references that you can implement to unlock the full immersive audio potential of your mod or plugin!

This is the service provider interface surface for the final class of a plugin, which should be configured to be imported by the service loader. It includes various default method calls meant to be overriden that are called at various points throughout Reactive Music's main flow.

⚠️ Setting up your plugin for import!


For Reactive Music to recognize your plugin, you must declare it in the resources folder of your project. Create the directory resources/META-INF and create the file circuitlord.reactivemusic.api.ReactiveMusicPlugin

Declare the package of your final plugin class extending ReactiveMusicPlugin like so:

yourname.yourmod.someplace.YourPluginClass

Now introducing the MochaMixAPI!

Reactive Music also includes a stable API to compile against that exposes views of various Minecraft objects and fields. For clearer separation on what is hooked into Minecraft, and what is hooked into Reactive Music systems - this API is included in a different package.

import rocamocha.mochamix.api;

Welcome to the wiki!

If you are new to modding and want to create a RM plugin click here.

Clone this wiki locally