CustomMusicMod
This mod allows you to add custom stage music, menu music, and victory themes!
About this mod Author’s original text
NASB Custom Music Mod
This mod allows you to add custom songs to each stage and menu in the game!
Changelog
v1.6.0
- Added support for Jenny's stage "Tremorton Joyride"
- When a custom song is played on Tremorton Joyride, that one song will play throughout the entire match
v1.5.4
- Fixed songs not loading (thanks DHNishi)
- Added Jenny's character id. NO stage support yet.
🚀 Installation
Slime Mod Manager
Download the latest version of this mod from the Slime Mod Manager!
ℹ Usage
Folder structure
BepInEx
↳ CustomSongs
↳ Menus
↳ ArcadeMap
↳ LoseV1...
↳ Stages
↳ CatDogs House
↳ Glove World...
↳ Victory Themes
↳ Aang
↳ April...
Place.wav,.ogg, or.mp3 files into the folder corresponding to the stage or menu you want to change.
For example, if you want to use a different song for the Jellyfish Fields stage, place the audio file in BepInEx\CustomSongs\Stages\Jellyfish Fields
If multiple audio files are in the same folder, one is randomly selected each time that stage / menu is loaded!
⟲ Loop points (optional)
To define a loop start and end point, create a JSON file in the same folder as your audio file, and give it the same name as your audio file.
A JSON file is just a regular text file, but instead of.txt it is.json
You may need to turn on file extensions on Windows to be able to see and edit the.json extension.
File structure example
Stages
↳ Jellyfish Fields
↳ Song1.wav
↳ Song1.json
JSON file contents
{
"loopStartPointSec": "16.109",
"loopEndPointSec": "62.215"
}
When 62.215 seconds have elapsed in the song, it will loop back to 16.109 seconds!
To find loop points in your song, you can use some free audio software like Audacity.
I would recommend using a DAW with more precise BPM / looping support, such as Reaper, Ableton Live, FL Studio, etc.
📝 Configuration
Run the game once with the mod installed to generate the config file:
BepInEx\config\megalon.nick_custom_music_mod.cfg
| Setting | Possible Values | Default | Description |
|-----|-----|-----|-----|
| Use Default Songs | true or false | true | Include the built-in songs when the mod is randomly selecting a song to play. However, character specific Victory Themes will always play, if available. |
| Skip OnlineMenu Music if Empty| true or false | true | If no song files are found in the OnlineMenu folder, the online menu music will not play. |
Simply edit this file in a text editor, and save it, then launch the game again.
❔ FAQ
"My.mp3 didn't work!"
I've had multiple people unable to load certain mp3 files.
If you've downloaded a file from a youtube downloader, such as ytmp3.cc, your file might actually be an.m4a disguised as a.mp3
Unity cannot load these (it seems).
Use a different converter, or convert to.ogg instead! Thanks.
"What happens if I have multiple songs in the same folder?"
The mod will randomly select a song to play each time that stage / menu / victory is loaded.
"Can I include the default songs in the random selection?"
Yes. You must enable the option in the config file. See Configuration above.
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide.
Install these first, or the mod will not work: