LTOWLethalCompanyBoomboxMod

Howdy, Pardner

To the lucky fella who happens to find this note:

Y'all mighta noticed the chests with equipment that have been left behind, carryin' some useful stuff, but there's one piece of equipment in particular I want to bring your attention to. It's a bona fide Boombox! Bought it from some company that claims to have truly professional employees.

That monumental relic not only plays some... (ahem)- "jammin' tunes", it also actually has a purpose that'll help you. It can work as a fair handful of fuel for the train, but the vibrations of its bass will also occassionally pierce the sands, possibly distracting the worm by making it seem like one of you pardners is movin' around.

Now hurry, ya got a train to catch...
- Gilbert

The Mod

Introduction:

Want to add a little something booming to your desert survival? Well, get ready, as this mod adds Lethal Company's Boombox to Wormtown!

It can be found in the same chests that other equipment such as rifles is found in, and it even includes all its original music! And it's high time to turn that grim desert into a groovy desert with this certified company jig. So now, get back to worm- uhm... work!

Customization:

Feel like adding your own playlist to the boombox? Or want to lengthen the amount of time you can enjoy the music? Then change it!

Go to this mod's Config file to change a handful of options, such as being able to load custom music from your own computer, setting for how long the boombox's battery can play, and how frequently a boombox that's lying on the sand will ping the worm's attention. There's a total of 9 customizable options, some of which affect the whole lobby while some are personal to your game only, so choose whatever fits you and your group!

Creation:

• My intention with this mod was to learn how to mod Wormtown from within a native Unity project, as opposed to just working in code.
  • This went really, really slowly, since there was no modding support for this game and thus no Unity-decompilers, and for some reason Unity version 2021 prevented me from importing the necessary assemblies despite version 2022 not doing that? Because of that, I also made this mod in v2022 instead of v2021 (what this game uses) as a last resort. I really hope it doesn't break...
• And, as you might have noticed, this mod first released as a v0.9.0 Test Release, since there was still stuff I wanted to change, but didn't want to keep this mod offline for too much longer.
  • The main things were the boombox's visuals not using the claymation effect and not turning invisible for the worm, these are now fixed.
  • But maybe some netcoding things will still need updating, and the sound could use a few extra touch-ups, especially when picking up and dropping the boombox.

Credits:

• Lethal Company, its boombox, and its model and sounds and music belong to Zeekerss, with a few songs having been made by ZedFox.
• Thanks to the people on the Wormtown modding discord server and to the TunnelersTrinkets mod for helping me understanding how to copy over the game's claymation effect to modded items.
• The loading of custom music into the boombox is directly inspired by, and reuses large swaths of code from, the Lethal Company mod Custom Boombox Music and its 'Fixed' counterpart.
• And thank you for checking out or even downloading this mod!

v0.9.0

• Test Release

v1.0.0

• Release
• Changes and Fixes:
  • The Boombox will now properly turn invisible for the worm when not touching the ground or when laying still
  • The Boombox won't grow to a massive size anymore when being eaten by the worm
  • The Boombox's model now also uses the game's claymation visual effect on its different parts
  • The Boombox will no longer spawn weirdly vertically, but with the handle at the top

v1.1.0

• The Boombox can now play custom music from your computer:
  • Copy-paste the songs you want the boombox to play into the Custom Music folder that is now in this mod's BepInEx plugin folder
    • This folder can be found through: Thunderstore Mod Manager > Settings > Browse profile folder > BepInEx > plugins > SimonTendo-LTOWLethalCompanyBoomboxMod > Custom Music.
    • The mod will load the music the first time you load into a lobby, and display its progress in the bottom left corner of the screen.
    • Due to technical limitations, only music files of type MP3, Wave, and OGG are supported.
• Added 7 more Config options:
  • [Worm Hears Boombox]
    • If true, the worm will be able to hear the boombox's music. If false, they will not be able to tell that there is a boombox playing music, useful for confusing it about the sand-pinging.
    • By default set to false; lobby host's values are used.
  • [Boombox Ping Interval]
    • This option sets how often, in seconds, a boombox that has been placed on sand will ping the worm's attention.
    • By default set to 4; lobby host's values are used.
  • [Boombox Has Battery]
    • If true, the boombox will have a limited battery lifetime, and will stop playing music and pinging the worm once it has run out of battery.
    • By default set to true; lobby host's values are used.
  • [Battery Lifetime]
    • If Config option [Boombox Has Battery] is set to true, this option sets for how long, in seconds, the boombox's battery will be able to play music before depleting.
    • By default set to 170 seconds; lobby host's values are used.
  • [Load Custom Music]
    • If true, this mod will try to load the music files you put into this mod's Custom Music folder.
    • By default set to true; local values are used.
  • [Add Or Overwrite]
    • If Config option [Load Custom Music] is set to true, this option will determine if your custom music will be added to the total playlist of songs while keeping the original Lethal Company songs, or if your custom music will try to be the only songs on the boombox.
    • By default set to true (Add); local valued are used.
• Added an on-screen tip on how to use the boombox while holding it in your hands.
• In case multiple boomboxes happen to spawn during the same round, they should now all use different randomized sequences of songs, rather than all following the exact same order.
• Cleaned up the boombox's model to strengthen the claymation effect and prevent verteces from detaching.
• Made some changes so the boombox hopefully more consistently pings the worm when on sand.

v1.1.1

• Made changes to the on-screen progress bar for loading custom music, to better communicate its results
• Changed the on-screen tip on how to use the boombox so that it hopefully also immediately displays for clients
• Made further changes to the boombox model to make it correctly display how "chomped" it is while being eaten by worms