Content Warning Spöökbox

Adds a silly boombox (The Spöökbox™) to the store so you can dance to any tune you want while going viral :]

IMPORTANT Everyone in your lobby must have the mod installed for it to work!

How to use

Loading music

Loading music can be done from multiple source directories. Keep in mind that you need to have your own mp3 files for this to work. Once you have the list of music you want to use, the simplest way to load them into the boombox is to go to your Music folder (%userprofile%\Music), create a folder called SpookboxMixtape, and copy your files in there.

IMPORTANT Everyone in your lobby must have the same mp3 files! Once you created a good list of tunes, send them to your friends and have them copy them into the above directory.

NOTE The maximum number of individual tracks that can be loaded is 255.

If you don't want to use your music folder, you can also use the mod's own tracks folder (note however that this will be deleted along with the mod when you uninstall it):

Once you have Content Warning and your profile selected in r2modman, go to Settings -> Browse profile folder. From there go to BepInEx\plugins\Xerren-Spookbox\SpookboxMixtape and copy-paste your music files. You can also make use of content mods. The boombox's music loader will scan all other mods for directories with the SpookboxMixtape name and load all music files within them automatically.

Thunderstore Content Mods

If you are using Thunderstore, you can also create content mods. These mods don't add extra functionality, but can provide extra assets to other mods; in Spöökbox's case this means you can create a content pack with music inside!

Follow the thunderstore guide to create a new mod. Add the dependency string from the mod's page to the manifest.json's dependencies array. Then, in the same folder with all your files, create a SpookboxMixtape folder, and copy all your music files into it.

Zip the entire base directory up (directory with the icon.png, manifest.json, readme.md files and the SpookboxMixtape folder), and upload it to Thunderstore. Done! :) Now your friends can download the content mod and be assured that you all share the same tunes.

Startup time

Tracks are loaded synchronously by default so it may take a few seconds for the game to start up, and it may appear frozen in the meantime. If you have an SSD or only a few songs, add "-ihaveanssd" to the Steam Launch Options for a much faster startup experience.

WARNING Setting this flag with a large number of tracks or a slow drive may cause issues; remove the flag and restart the game if you experience desync problems with the music.

In-game settings

Settings that affect the experience for everyone are designed to be quickly adaptable during gameplay. For example, the host can set the boombox's battery to no longer discharge. This will automatically synchronise for every player in the lobby, but will not change your own settings, so while the effect will be the same for every player, visually the toggle may be off in their own settings menu.

NOTE This may be confusing at first glance but it is deliberate, so when the next time you are the one hosting a game, your settings will be unique to you, instead of whatever your friends had. These settings are suffixed with [HOST], meaning only the current lobby's host's changes will have effect; if you are not the host, changing these will do nothing.

Local boombox volume

Controls all boombox's local maximum volume. While you can still change their individual, shared volume during gameplay, you can use this slider to personalise how loud you want the music to be on your end (similar to the other volume sliders in the settings). Sometimes TUCA DONKA blasting in your ear can be a bit too much. I get you.

Volume Up and Down Keys

Each boombox has an individual volume setting, so you can control how annoying loud each of you are. By default it is always 50%, but you can change it by pressing these keys. This is synchronised between player for the specific boombox instances.

[HOST] "Let BigSlap hear the tunes"

You know what this does (alerts nearby monsters) (also affects other monsters). Only the host can set this, but they may freely change it anytime during the run (which will affect everyone).

[HOST] Infinite battery

Check this if you don't want the boombox to ever run out of battery. Only the host can set this, but they may freely change it anytime during the run (which will affect everyone).

[HOST] Price

Sets the boombox's price. By default it is 100$. Only the host can set this. Once a lobby has been created, changing it will have no effect until a new lobby is started, so set this early, before starting a game.

Credits

Model: My dearest friend, Cinnaboop <3

Emotional support: Echo (was in the call) :]

Click SFX (slightly edited): Tape Start 139BPM Sync by djlprojects -- https://freesound.org/s/392890/ -- License: Attribution 4.0