You are viewing a potentially older version of this package. View all versions.
kerotein-YPlayBoombox-2.2.1 icon

YPlayBoombox

Play YouTube audio and music on your boombox! NOTE: All players must have this installed to hear it too!

Date uploaded 2 days ago
Version 2.2.1
Download link kerotein-YPlayBoombox-2.2.1.zip
Downloads 3079
Dependency string kerotein-YPlayBoombox-2.2.1

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100

README

YPlayBoombox

YPlayBoombox

Description

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

YPlayBoombox

Features

  • Audio syncing between players.
  • Audio pausing and resuming.
  • Play audio on separate boomboxes.
  • Playback history and navigation.
  • Customisable boombox colors.
  • Networked volume control and local muting.
  • Low memory and disk space usage.
  • Play without the host (offline mode).
  • Handsfree playback (with "Boombox pocket play" enabled).
  • Audio duplication (with "Boombox sync" enabled).
  • And much more...!

Dance to the music!

YPlayBoombox
[YouTube Demo]

Installation

  • All players must have this installed and up to date to hear the audio.
  • Install using a compatible mod manager or extract the YPlayBoombox folder into your BepInEx/plugins folder.
  • Disable/uninstall other boombox mods as they may interfere.

Commands

To use YPlayBoombox, hold or look at a boombox and then:

  1. Open the chat by pressing the / key.
  2. Type /yplay or /yp followed by a space and then any of the following commands (enter your own value instead of the square brackets):
Section Command        Alt Example Notes
Load audio [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 history
history [index]
h, hist /yp history
/yp history 2
/yp history will show you a list of your previously entered URLs. Include an index to replay it.
Change playback time time [seconds] t /yp time 60 YouTube timestamps are also supported, right click the video and click "Copy Video URL at current time".
Change color color [r,g,b]
color [color]
c, col /yp color 255,255,255
/yp color white, random, rainbow
You can find all valid color names on [w3schools].
Change volume volume [1-10] v, vol /yp volume 6
Mute boombox locally mute
mute all
mute none
m /yp mute all Clientside command that will mute the boombox for you only, this will not affect what other players hear.
Force offline mode offline /yp offline Clientside command that disables networking if YPlayBoombox is not working on the host.
Reset tools reset-tools /yp reset-tools Clientside command that redownloads the tools if they are invalid.

Keybinds

Section Description Default Key Notes
Sync boombox Sync the boombox you are holding to the boombox you are looking at, or resync if the audio is not downloaded. Q Only available if "Boombox sync" is set to "true" in the config.
Reset boombox Reset the playback time of the boombox to 0 and stop playback. R
Mute boombox locally Toggle mute on the boombox just for you. Backspace Clientside command that will mute the boombox for you only, this will not affect what other players hear.
Boombox volume up Increase the boombox volume. PageUp
Boombox volume down Decrease the boombox volume. PageDown

Settings

Section Description Default Value Host Override Notes
Boombox pocket play Allows the boombox to continue playing in the inventory. false Yes
Boombox sync Allows the boombox to copy the audio and time of another boombox, and also allows multiple boomboxes to play the same audio. false Yes Resource intensive but offers more features/accurate syncing.
Boombox random color Boomboxes are spawned with a random color! false Yes

Notes

If you come across any problems, please check the [Wiki] which contains up-to-date information.

CHANGELOG

  • 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