Required by all clients.

When mods update, they reset the contents in the mod's corrensponding plugin folder. As such with the previous Copy and Paste Method, the boombox folders would be deleted. My apologies if your files were deleted. You can check out the new method below.

Your Own Personal Boombox

An API to easily create your own personal boombox with your own songs that's separate from the in-game boombox.

To add your boombox, you can either create a mod or use the tried-and-true'd Drag and Drop method. See below to see how.

Only a maximum of 10 boomboxes can be loaded currently. You can edit the maximum volume of all boomboxes in the config.

The Drag and Drop Method

Once you download and install this mod, run Lethal Company once. This will create a Your Own Personal Boomboxes folder in the plugins folder. If you don't know how to find this folder, go to your r2modman application and open the settings tab. Look for the Browse profile folder option and click on that. From there, open the BepInEx folder then the plugins folder. The Your Own Personal Boomboxes folder should be there.

Inside the Your Own Personal Boomboxes folder is an EXAMPLE.zip file. Extract the contents into a new folder, and insert your music into that folder. You can edit the data.json file to edit the boombox's properties. You can also add a decal.png file to give it some flare. See below for what those are. You can create as many boombox folders as you like.

If you intend to use these boomboxes in multiplayer, your friends MUST have these exact same folders and files. Otherwise very weird bugs will happen.

Folder Structure

Refer to this image for the folder structure. The boombox folders (the folder with just songs and such) MUST be in the plugins/Your Own Personal Boomboxes folder.

The folder's name does not matter. DO NOT edit data.json file's name.

The Create a Mod Method

See here for an example mod. You can copy and paste the template code from here.

Code wise, please update the following strings or values. These are found near the top of the template code.

%YOUR_MOD_NAME%         -> YOUR_MOD_NAME
%YOUR_MOD_NAME_PLUGIN%  -> YOUR_MOD_NAME_PLUGIN
YOUR_UNIQUE_GUID        -> "YOUR_USERNAME.YOUR_MOD_NAME"    // in this format "x.x"
YOUR_MOD_NAME           -> "YOUR MOD NAME"
YOUR_VERSION            -> "YOUR_MOD_VERSION"               // in this format "x.x.x"

An example could be like

%YOUR_MOD_NAME%         -> MyAmazingBoombox
%YOUR_MOD_NAME_PLUGIN%  -> MyAmazingBoomboxPlugin
YOUR_UNIQUE_GUID        -> "xXMadSnipezXx.MyAmazingBoomBox"
YOUR_MOD_NAME           -> "My Amazing Boombox"
YOUR_VERSION            -> "1.0.0"

Don't forget the "" for the last 3 strings. Also do not forget the . in the GUID and VERSION strings.

Folder Structure

Refer to this image for the folder structure. Inside the package folder (the folder with the .dll file, manifest.json file, etc.), create a plugins folder.

From either the example project OR the BepInEx/plugins/Your Own Personal Boomboxes folder, find the EXAMPLE.zip file. Extract its contents into a new folder inside the plugins folder. Insert your music into the newly created boombox folder. You can edit the data.json file to edit the boombox's properties. You can also add a decal.png file to give it some flare. See below for what those are. You can create as many boombox folders as you like.

The folder's name does not matter. DO NOT edit data.json file's name.

If you want to know why we have to create a plugins folder, see here to why.

data.json

Name refers to the boombox name. It does not have to be unique but it should be recognizable. The text's maximum length is 20.

Description refers to the text displayed by the terminal INFO command.

Price refers to boombox's cost in the terminal. The range is 0 to 1000.

Volume refers to the boombox's volume. The range is 0 to 1. A good starting value is 0.4 or 0.5 so you don't blow your friend's eardrum.

Red, blue, and green refers to the boombox's model RGB color in-game. You can find the RGB values of any color by a quick google search or even this site.

decal.png

You can add a decal to the back of your boombox. In the same folder with the songs and data.json file, add a decal.png file. There is no size requirement but currently the picture will scale to a square. Support for other sizes will be added later.

How to check for problems

In the main menu, there is a music note button in the top right. Clicking on that will give you a debug log. The boomboxes and songs loaded will be displayed, along with any errors.

Current limitations, issues, and future features

Only a maximum of 10 boomboxes can be loaded currently. This will be increased to 20.

It currently only supports .mp3 files. This is just maximum laziness atm.

The boombox model recoloring is just tinting the in-game texture. As such, you cannot get a white boombox. This will be addressed.

The boombox item icon does not change color. This will be addressed.

There is no volume control in game. This will be added.

An option to send a boombox and its songs through the network will be added.

Contact

Any complaints or questions can asked in this discord thread. You can also dm personally at this discord, LadyRaphtalia.

1.1.0

Added decal support
Added debug button at the main menu
Speeded up the music loading
Added support for mods to override their boombox prices with configs

1.1.1

Increased the boombox limit to 10
Changed where the boombox files are read from
Some UI cleanup

1.2.0

Fixed a network bug caused indirectly by IntroTweaks
Item icons now match the model's colour

1.3.0

Increased the boombox limit to 15
Decals will now scale to fill the boombox's backside
Improved visuals of debug window

1.4.0

Added volume control
Added fun config options for the boombox's
Decals use the game's postprocessing effects

1.4.1

Fixed the netcode

1.4.2

Verified to work for v47

1.4.3

Verified to work for v50

1.4.4

Fixed visual bug with Terminal Formatter