Subscribe to download
Soundtrack Menu

This mod lets you change the soundtrack in-game by using the Mod Config Menu.


You don't need both.

IF YOU ARE USING MUSIC CALLBACK MAKE SURE YOU USE THE CORRECT VERSION

If it's missing a requirement it will not appear in the config menu and there will be an error message in the debug console.



With this mod you can change the games music on the fly without even needing to go back to the main menu, you can pick a specific soundtrack, set it to shuffle between various soundtracks, or even pick and choose individual tracks from each soundtrack to make your own custom soundtrack.
(or totally randomize the tracks for complete chaos)

Want the classic flash music for the basement and antibirth's downpour music for flooded caves? you can do that, you want every single boss fight to play 'Fast Track to Browntown'? sure you can do that too, for each default track in the game you can pick a song to play instead by selecting a soundtrack and trackname.


Just press F10 and go to 'Set Soundtrack', or 'Potato Pack 2' and then scroll sideways until it says Soundtrack.


On top of having the regular rebirth soundtrack I have added soundtracks from some of Edmunds other games, plus a couple soundtracks from AB+ modpacks.
The soundtracks included are: Rebirth, Flash Isaac, Antibirth, Super Meat Boy, The End is Nigh, Legend of Bum-bo and Genesis+.

More soundtracks can be added to the menu by compatible mods.

Each soundtrack has an option you can change that sets whether it can be used in shuffle and randomization and how often it should be used.

You can press N at any point in game to skip to the next soundtrack when in shuffle or random modes. (or custom with shuffle/random options)


The menu will include 1 soundtrack added by mods that aren't compatible (listed as 'Default'), but it can't add multiple non-compatible soundtracks, they all overwrite the same files/track ids so only the most recently loaded one can be used.


In the 'Custom' mode you can set each individual (controllable) music track in the game to a specific soundtrack and tracktype of your choice, among the options for soundtrack are 'Silent, 'Random' and 'Shuffle'.

Each individual entry set to random will be a different soundtrack, while the ones set to shuffle will all share a single randomly chosen soundtrack, e.g. if you set both basement and shop music to shuffle you might get flash music when starting the floor and when entering a shop it would play flash shop music, but if you set both basement and shop music to random you could have a basement playing antibirth music and then you enter a shop and it plays supermeatboy music.

Both random and shuffle tracks will change every so often based on your settings, either on room change, on floor change or on starting/continuing a run.

If you want multiple different 'custom' soundtrack set ups, or if you want certain tracks to have a different 'shuffle list' than others, that can be done with a bit of lua using the
More Custom Soundtracks mod.



Thanks to Broski for showing me the music API and giving me the idea for this mod and for the Genesis+ soundtrack.
Thanks to Taz for making the music API and Piber for making the mod config menu.


If you're having issues with music while in custom stageAPI floors try opening the config menu, going left to "Other Options", then down to the stageAPI setting and set it to "No Soundtrack Menu music for StageAPI floors".


Note that this mod can't control the music for the intro cutscene or end credits, and without Repentogon it can't control the music for the title screen, the run start jingles or the pre-floor nightmare jingle. (you can still change those with a 'default' music mod)

But it DOES let you set a track specifically for Mega Satan, just call the track "SOUNDTRACKNAME Boss (Mega Satan)".

If you have Repentance you can also set a track specifically for phase 1 of the Hush fight instead of reusing the ??? music, just call the track "SOUNDTRACKNAME Boss (Hush Phase 1)".

If you have REPENTOGON then soundtracks can have custom jingles for the run start and custom music for the main menu and pre-floor nightmare.
To change the main menu music and run start jingle settings go through the main soundtrack selection and go left past the "Jingles only" mode (or right past all your installed soundtracks), once you've updated the settings then just change the soundtrack selection back to whatever soundtrack you want to use in game play.
The tracks should be titled in the music.xml like this:
"SOUNDTRACKNAME Main Menu"
"SOUNDTRACKNAME Run Start"
"SOUNDTRACKNAME Tainted Run Start"
"SOUNDTRACKNAME Nightmare"
"SOUNDTRACKNAME Dogma Nightmare"

Another Repentogon exclusive feature is Continuous Floor Music, this can be enabled in the options section of the soundtrack menus config page, it works by playing the room music as a 'jingle' and silencing the regular music, so unfortunately leaving and re-entering a room will restart the rooms music and if you enter a room while a jingle is playing it will get cut off by the rooms music, but otherwise it should work as you would expect.



If you made a soundtrack mod adding compatibility is fairly easy, just follow the instructions in the discussion topic.


Check them out and add more tracks to the menu, you can also use them as examples for making/updating your own mods.


IF YOU EXPERIENCE A BUG PLEASE TRY UNSUBSCRIBING FROM THIS MOD, DELETING THE MOD FROM YOUR MODS FOLDER, RUNNING THE GAME WITHOUT IT, THEN RESUBSCRIBING.
(you'd be surprised how often that solves problems with mods)
If that doesn't work check your debug console for errors when you experience the issue.
(and include any error messages in the bug report)
If there's no errors try disabling all non-required mods (that aren't basic soundtrack mods) and seeing if the issue still happens, if that helps see if you can determine which mod causes it and let me know, either way please post the issue in the Bug Thread discussion while also letting me know whether you're using Repentogon or MMC.




This is included in POTATO PACK 2.