Configured Youtube Boombox

v0.3.1·Updated 2024-01-12

Lethal Company plugin for creating boombox song packs from YouTube content

About this mod Author’s original text

Lordfirespeed-Configured_Youtube_Boombox (CYTBB)

A BepInEx plugin for Lethal Company that downloads audio from YouTube for use with

Steven's Custom Boombox Music.

Configuration

  • Create a subdirectory in your BepInEx/plugins directory, e.g. myTracksMod.
  • Create a new JSON file called configured-youtube-boombox-tracks.json in the BepInEx/plugins/myTracksMod folder.

Paste this template into the file:

{

"$schema": "

"tracks": [

{

"youtubeVideoId": "yourVideoIdHere",

"trackName": "yourTrackName"

}

]

}

  • Replace the youtubeVideoId and trackName accordingly.
  • Specify extra options such as startTimestamp, endTimestamp, volumeScalar (See

here for an example)

  • Add additional tracks by adding more items to the array
  • That's it! CYTBB will download the listed tracks from Youtube into the BepInEx/Custom Songs/Boombox Tracks folder

when the game is opened.

Tracklist Reference

youtubeVideoId

Required string. Determines the source YouTube video. See this gist

for how to get YouTube video IDs.

trackName

Required string. Will be formatted into the.mp3 track's filename once downloaded, cytbb-[trackname]-[youtubeId].mp3

startTimestamp

Optional string of form h:m:s. The downloaded audio will be cropped to start at this timestamp.

Seconds can be a decimal quantity and leading zeroes can be omitted. For example:

  • ✅ 128.95 (128.95 seconds)
  • ✅ 2:08.95 (2 minute 8.95 seconds)
  • ✅ 1:35:20.12 (1 hour, 35 minutes and 20.12 seconds)
  • ❌ 35:94 (can't have >=60 seconds when specifying minutes)
  • ❌ 1:62:30 (can't have >=60 minutes when specifying hours)

endTimestamp

Optional string of same form as startTimestamp. The downloaded audio will be cropped to start at this timestamp.

FAQ / Common Issues

Other players are hearing different songs to me!

Desync will occur if players have different tracklists. Make sure all players have the same custom boombox tracks

to ensure synchronicity.

I've made configured-youtube-boombox-tracks.json but nothing is being downloaded!

CYTBB will not search for tracklists recursively. Your tracklist must be inside a folder in BepInEx/plugins.

For example:

  • ✅ BepInEx/plugins/portalRadio/configured-youtube-boombox-tracks.json
  • ❌ BepInEx/plugins/portalRadio/youtube-boombox-tracks.json (wrong filename)
  • ✅ BepInEx/plugins/pirateSongs/configured-youtube-boombox-tracks.json
  • ❌ BepInEx/plugins/pirateSongs/tracks/configured-youtube-boombox-tracks.json (extra tracks folder)
  • ❌ BepInEx/plugins/configured-youtube-boombox-tracks.json (missing subfolder)

What is that $schema property in the template for?

The $schema property is a link to a JSON Schema which

provides helpful validation and autocomplete features in supported text editors.

Contributing

You will need to create a ConfiguredYoutubeBoombox/ConfiguredYoutubeBoombox.csproj.user:

F:/SteamLibrary/steamapps/common/Lethal Company

$(APPDATA)/r2modmanPlus-local/LethalCompany/profiles/Test Configured YT Boombox

$(SolutionDir)NetcodeWeaver

Install & use Install: BepInEx plugin

  1. The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
  2. Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
  3. Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
  4. Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.

Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file.

Dependencies

Install these first, or the mod will not work:

BepInEx-BepInExPackLordfirespeed-YoutubeDLSharp

File & checksum

Filename
Configured_Youtube_Boombox-0.3.1.zip
File size
158.2 KiB