CustomBoomboxMusic

About

This mod is intended to simplify the creation of mods, that add more songs to the Boombox.

The original Custom Boombox Music mod is not directly compatible with mods installed via Thunderstore Mod Manager or r2modman. This mod aims to fix that, and generally provide more stability and reliability.

IMPORTANT (READ IF CREATING MODPACK)

By default, this mod is completely client-sided, however it supports track synchronization.

If everyone has this mod, simply disabling the ClientSide config value is recommended, as it will synchronize the currently playing track among all players.

That way it is guaranteed that everyone hears the same music, and there is basically no risk of the "playlist" de-syncing.

Usage (creating your music mod)

Simply create a directory with the following files and folders (replace MyPlugin with your mod name):

MyPlugin
├── manifest.json (Mod information, see below)
├── README.md (Text displayed on mod page, like the one you're reading right now, can be empty)
├── icon.png (Your mod icon, must be 256x256 pixels)
└── BepInEx
    └── plugins
        └── CustomBoomboxMusic (Your music files go in here)
            ├── Artist - Title.mp3
            ├── Example Artist - Example Song (Example Game).ogg
            └── music.m4a

It is recommended to name your music files as shown (Artist - Title (Source)), since the user will see a "Now Playing" popup displaying the file name.

Example:

Now Playing:
Example Artist - Example Song (Example Game)

If synchronization is enabled, but you do not have the corresponding song loaded, a warning will be displayed and a placeholder song will play instead:

Missing audio:
Example Artist - Example Song (Example Game)
(CRC32: 12345678) could not be played

The following file extensions are supported:

• .mp3
• .ogg (vorbis)
• .wav
• .m4a (aac)
• .aiff

manifest.json:

The manifest.json file contains general information about your mod.

This is the general format:

{
  "name": Mod name,
  "version_number": Version number, in format major.minor.patch. This has to be increased every time you upload a new version of your mod,
  "website_url": Website url, can be left empty,
  "description": A short description of your mod,
  "dependencies": A list of dependencies, should be ["baer1-CustomBoomboxMusic-<VERSION>"]
}

Example:

{
  "name": "MyPlugin",
  "version_number": "1.0.0",
  "website_url": "",
  "description": "My cool boombox music plugin",
  "dependencies": ["baer1-CustomBoomboxMusic-2.0.1"]
}

You can verify your manifest.json file here.

Uploading

Simply zip the contents of your folder and upload them to thunderstore.io

You should be able to install it through your mod manager after about 3 hours