YPlayBoombox

Listen to YouTube audio on your boombox and cruiser with your friends!

Features

• Accurate audio pausing, resuming, and syncing between players.
• Networked customizable boombox colors.
• Networked volume control, with local muting.
• The ability to play different audio on separate boomboxes.
• The ability to play without the host (offline mode).
• Playback history to play your previously entered URLs.
• Progress updates so you know exactly when each player is ready.
• Simple error reporting and documentation.
• Low memory and disk space usage (files are stored temporarily while in the lobby).
• Handsfree playback, so you can continue playing audio while it is in your inventory (with "Pocket play" enabled).
• Audio duplication, which enables you to play the same audio as another boombox or cruiser (with "Sync" enabled).

Installation

• All players must have the latest version of YPlayBoombox installed to hear the audio.
• Install using a compatible mod manager or place the YPlayBoombox folder into your BepInEx/plugins folder.
• You may need to disable other boombox and cruiser mods if they cause compatibility issues.

Usage

To use YPlayBoombox:

1. Hold or look at a boombox, or sit in a cruiser.
2. Type /yp into the chat, followed by a space and then any of the following commands:
   Round brackets - select a value, square brackets - enter your own value.

Commands

View all commands
/yp

Load audio
/yp [url]
/yp https://www.youtube.com/watch?v=dQw4w9WgXcQ
You can grab the YouTube URL by right-clicking the video and clicking "Copy Video URL".

View and select play history
/yp (history | hist | h) ?[index]
/yp history
/yp history 2

Actions
/yp actions
View a list of possible commands that can be used on the boombox and cruiser.

Boombox and cruiser

Change playback time
/yp (time | t) [seconds]
/yp time 60
YouTube timestamps are also supported, right click the video and click "Copy Video URL at current time".
Seek accuracy is not guaranteed.

Mute locally
/yp mute ?(none | all | always)
/yp mute all
"always" will mute all boomboxes and cruisers until turned off using the "/yp mute none" command.

Boombox only

Change color
/yp (color | col | c) ([r,g,b] | [color] | random | randomloop | rainbow)
/yp color 255,255,255
You can find a list of valid color names on [w3schools].

Change volume
/yp (volume | vol | v) [1-10]
/yp volume 5

Settings

Settings
/yp (settings | config | conf)
View the current YPlayBoombox settings.

Sync
/yp sync
Toggle sync for the lobby (if host), this is saved in the host config.
This command can only be used if no download has been initiated yet. Restarting the lobby will allow this command to be used.
See "Config" below for more information about this command.

Pocket play
/yp (pocketplay | pocket | pp)
Toggle pocket play for the lobby (if host), or for you (if offline), this is saved in the host config.
See "Config" below for more information about this command.

Boombox random color
/yp (boomboxrandomcolor | brandcolor | brc)
Toggle boombox random color for the lobby (if host), or for you (if offline), this is saved in the host config.
See "Config" below for more information about this command.

Misc

Status
/yp (status | stat)
View the network mode and installation information.

Reset tools
/yp reset-tools
This will redownload FFmpeg and yt-dlp which are used to download the audio - this command is useful if they are invalid.

Offline mode
/yp (offline | off)
This will disable YPlayBoombox networking between you and the host.
Offline mode is not recommended, as it will create different play states between players.

Keybinds

Sync
Q
Rebindable
Sync to another boombox or cruiser, or resync (redownload) the audio.
Only available if "Sync" is enabled in the config.

Reset
R
Rebindable
Reset the playback time to 0 and stop playback.

Mute locally
Backspace
This will mute the boombox or cruiser for you only, and will not affect other players.

Boombox volume up
PageUp
Rebindable
Increase the boombox volume.

Boombox volume down
PageDown
Rebindable
Decrease the boombox volume.

Play history next
RightArrow
Rebindable
Navigate to the next page in your play history.

Play history previous
LeftArrow
Rebindable
Navigate to the previous page in your play history.

Config

Sync
false* | true
Overriden by host
Copy the audio and time of another boombox or cruiser, and allow them to play the same audio.
This is resource intensive but offers more features and accurate syncing.

Pocket play
false* | true
Overriden by host
Default: false
Allow the boombox to continue playing in the inventory.

Boombox random color
false* | true
Overriden by host
Boomboxes are spawned with a random color!

Notes

If you come across any issues while using YPlayBoombox, please check the [Wiki] for help.

• 2.3.6

  • Updated tools
  • Updated error failure logic

• 2.3.5

  • Fixed error catching preventing download

• 2.3.4

  • v70 compatibility

• 2.3.3

  • Updated tools

• 2.3.2

  • Updated tools
  • Changed format selection

• 2.3.1

  • User interface fixes

• 2.3.0: ONE YEAR ANNIVERSARY UPDATE!

  • Added support for the cruiser!
  • Fixed error when changing boombox color on invalid mesh renderer
  • Improved compatibility with chat modifying mods
  • Improved resync accuracy
  • Improved error reporting
  • Stricter offline mode networking
  • Added mute "always" command
  • You can now mute boomboxes in another player's inventory
  • Sync, pocket play and random boombox color can now be toggled in game, this is saved in the host config
  • Synced config changes will no longer save on non-hosts
  • "rainbow" boombox color is now a gradient (added "randomloop" as a replacement)
  • Changed the download timeout to be based on the audio length
  • Updated config
  • User interface changes

• 2.2.1

  • Boombox color range fix

• 2.2.0

  • Tools verification changes
  • Moved audio folder to temporary files directory
  • Moved tools folder to Lethal Company directory (prevents unnecessary redownloading)
  • Added reset-tools command
  • Added colored boombox color text
  • Commands can be prefixed with a dash again
  • Added config tag to console messages
  • Warn host if a request fails because of them

• 2.1.4

  • Skip checking for existing tools if they already exist
  • Fixed wrong video id being shown for some requests
  • Fixed YPlayBoombox not working with some mods

• 2.1.3

  • Fixed invalid URL error not being caught
  • Potential fix for getting stuck in downloading tools state
  • NiceChat compatibility patch (messages will no longer delete the rest of the chat history)

• 2.1.2

  • Fixed time parameter not always working

• 2.1.0-2.1.1

  • Fixed whitespace in multi-commands
  • Added help (displays the YPlayBoombox wiki link) and status commands
  • Fixed temporary files not deleting
  • Fixed audio clearing prematurely when using multiple boomboxes
  • Fixed cancellation exception
  • Boombox will now unmute locally automatically if muted and toggled on
  • Removed "random" boombox color aliases
  • Potential conflicting mods warning will now only show in the console
  • User interface changes

• 2.0.4

  • Temporary file management

• 2.0.3

  • Fixed "Boombox sync" keybind working even if it was disabled
  • Temporary file cleanup
  • Increased maximum audio duration to 12 minutes

• 2.0.1-2.0.2

  • Bug fixes

• 2.0.0

  • Fixed YPlayBoombox not working on some boomboxes
  • Changed bindable mute key from [#] to [Backspace] for compatibility with more keyboard layouts
  • Added "rainbow" boombox color
  • User interface changes
  • Added YPlayUtil.dll dependency
  • Changed mod folder structure
  • Updated tools and added checksum
  • Asynchronous tools downloading
  • Increased server-side timeouts
  • Audio normalisation

• 1.1.4

  • Changed chat message implementation to improve mod compatibility
  • Removed bindable mute key [M], now changed to [#] for compatibility with TooManyEmotes random emoting
  • Possible fix for the boombox showing as muted
  • Added more boombox colors
  • User interface changes
  • Updated tools

• 1.1.3

  • Fixed keybinds activating in the terminal menu
  • Fixed random boombox colors sometimes not working
  • Fixed resync not being available when "Boombox sync" was disabled
  • Increased server-side timeouts
  • Fixed long URLs not loading in offline mode

• 1.1.0-1.1.2: ONE MONTH ANNIVERSARY UPDATE!

  • Audio resuming and syncing now only apply to YPlayBoombox audio
  • Improved mod compatibility
  • Play history formatting
  • You can view your play history without a boombox
  • Added server-side timeouts
  • Improved multi-boombox sync
  • Improved memory management/reduced memory usage
  • Boombox volume can be set to 0
  • Boombox can be muted locally
  • Tools caching changes
  • Improved stability
  • Added randomized boombox colors ("Boombox random color" in the config, disabled by default)
  • Added warning if the host does not have YPlayBoombox installed or there is a version mismatch
  • Added boombox resync for late-joiners
  • Updated and optimised user interface
  • Added more informative logging
  • Added experimental offline mode so you can bring your music with you wherever you go (even if the host doesn't have YPlayBoombox installed!)

• 1.0.8

  • Tools caching
  • Play history now shows the most recently played audio first
  • URL parsing fix

• 1.0.7

  • Fixed encoded titles not downloading
  • Fixed error messages not sending

• 1.0.5-1.0.6

  • Improved audio syncing

• 1.0.4

  • Fixed audio file limits
  • Audio quality changes

• 1.0.1-1.0.3

  • Fixed invalid package

• 1.0.0

  • Initial release