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.

This mod is based on modifications of Custom Boombox Music by baer1 . This mod allows you to play songs via Netease Music links or direct file links by using commands.Scroll down to learn about commands.
If you have any problems, please create an issue on GitHub to let me know.

This mod is completely compatible with most other mods for custom boombox music, however they will display as Boombox <number> (Lethal Company).

Most of the time you can simply rename the folder from Custom Songs (or any other name) to CustomBoomboxMusic and it should be picked up by this mod without any other modifications.

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
        └──
           Current Mod Folder
           └── CustomBoomboxMusic (Your music files go in here)
              ├── Artist - Title (Album).mp3
              ├── Example Artist - Example Song (Example Game).ogg
              └── Composer - Title [Remix, Slowed, Looped].m4a

It is recommended to name your music files as shown (Artist - Title (Album/Source) [Modifications]), 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 formats are supported:

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

Chat commands

This mod has optional support for chat commands, which allow you to play specific tracks at will or dynamically reload all audio files.

Command usages and examples:

!boombox r[eload] - completely reloads all audio files, freezes the game   
!boombox l[ist] - list all loaded tracks   
!boombox p[lay] <track> - Plays a specific track by CRC32 or name, Example: '/boo p Boombox 5' - plays boombox 5 from vanilla lethal company   
!boombox v[ersion] - Displays version information   
!boombox nlink/nurl <Netease Music song url> - Plays a FREE song in a Netease Music link.   
!boombox dl[ink]/durl <Direct file link> - Plays a FREE song via a direct file link. 
!boombox br/bypassReverb <true/false> - Disable the Reverb effect on a boombox that you are holding.

Supported mods

The following mods are explicitly supported:

• SpectateEnemies by AllToasters (v2.7.0)

Partially supported mods

The following mods are not explicitly supported, but they also don't cause any noticeable errors:

• BoomboxAutonext by Rattenbonkers
• OrderedCustomBoombox by Hackattack242

Unsupported mods

The following mods are explicitly NOT supported, either causing errors, not fulfilling their purpose or this mod already having an equivalent function:

• BoomboxSyncFix by FutureSavior