The Binding of Isaac: Rebirth

The Binding of Isaac: Rebirth

INNER SANCTUM (Soundtrack Overhaul)
AceHand 24 Aug, 2024 @ 3:20am
Main Lua file
Would you consider adding a main Lua file to the mod, as it currently seems to lack one entirely?

The reason I ask is because with this addition other mods would be able to check the existence of your mod, and I'd like to add the names of the tracks to the What's That Song? mod, but currently that would be excessively difficult, if not impossible, to implement.

Really, the only line you need in the file is the following, where [YourModName] is the name of your mod.

[YourModName] = RegisterMod("[YourModName]", 1)
Last edited by AceHand; 24 Aug, 2024 @ 3:24am
< >
Showing 1-11 of 11 comments
Hengus McMann  [developer] 27 Aug, 2024 @ 3:31pm 
Hey, yeah! I do wanna get around to adding this, and even tried to get it working with the Soundtrack Menu but couldn't figure it out
Would it just be this one line of code?
AceHand 29 Aug, 2024 @ 3:31am 
Yeah, with this one line of code, other mods would be able to check if your mod is in use, and then do something if it is.

If you wanted to implement functionality with Soundtrack Menu, you would have to modify your music.xml file's structure a bit, namely, change each element from the current format:

<track id="1" name="Basement" intro="Diptera Sonata Intro.ogg" path="Diptera Sonata(Basement).ogg" layerintro="Diptera Layer Intro.ogg" layer="Diptera Layer.ogg" loop="true" />

into this format (not sure if you can keep the id):

<track name="Inner Sanctum Basement" intro="Diptera Sonata Intro.ogg" path="Diptera Sonata(Basement).ogg" layerintro="Diptera Layer Intro.ogg" layer="Diptera Layer.ogg" loop="true" />

Additionally, you would have to include this code in your main.lua file:

[YourModName]:AddCallback(ModCallbacks.MC_POST_GAME_STARTED, function() if SoundtrackSongList then AddSoundtrackToMenu("Inner Sanctum") else Isaac.ConsoleOutput("Soundtrack Menu is required for adding the Inner Sanctum soundtrack!\n") end end)

Also, do ask if you have any questions regarding implementing these features!
Last edited by AceHand; 29 Aug, 2024 @ 3:35am
Hengus McMann  [developer] 9 Sep, 2024 @ 12:18pm 
Holy cow, you are a godsend; I somehow did not see this until now but this helps a whole lot; thank you so much!
Hengus McMann  [developer] 9 Sep, 2024 @ 12:20pm 
Ideally I would want it so that the mod doesn't rely on the soundtrack menu, so it can run independently if people don't want that. Would that be impossible, or is there like, a workaround?
AceHand 12 Sep, 2024 @ 3:49pm 
Yeah, I didn't have notifications on for this discussion either. :D

Anyway, I'm certain that's possible, but I'm WAY too busy at the moment to really look into that personally. I wish you luck with the mod regardless, and hope you find a solution for it!
Last edited by AceHand; 12 Sep, 2024 @ 3:50pm
ohlordhebacc 25 Nov, 2024 @ 4:30pm 
Originally posted by Hengus McMann:
Ideally I would want it so that the mod doesn't rely on the soundtrack menu, so it can run independently if people don't want that. Would that be impossible, or is there like, a workaround?
it should be possible by having 2 music.xml files: the current, non-soundtrack menu compatible file goes into the "resources" folder, and the compatible file goes into the "content" folder.

you'll also need to have a different path to the music than the default, otherwise the music files might be overridden by other mods: make a subfolder named "inner sanctum" (or whatever name you want) inside the "music" folder and move the music files into the "inner sanctum" subfolder, then change the line
root="music/"
to
root="music/inner sanctum/"
in both music.xml files. if i explained something poorly, feel free to tell me.
AceHand 26 Nov, 2024 @ 1:36pm 
Originally posted by ohlordhebacc:
Originally posted by Hengus McMann:
Ideally I would want it so that the mod doesn't rely on the soundtrack menu, so it can run independently if people don't want that. Would that be impossible, or is there like, a workaround?
it should be possible by having 2 music.xml files: the current, non-soundtrack menu compatible file goes into the "resources" folder, and the compatible file goes into the "content" folder.

you'll also need to have a different path to the music than the default, otherwise the music files might be overridden by other mods: make a subfolder named "inner sanctum" (or whatever name you want) inside the "music" folder and move the music files into the "inner sanctum" subfolder, then change the line
root="music/"
to
root="music/inner sanctum/"
in both music.xml files. if i explained something poorly, feel free to tell me.
I can confirm this to be the case. Apparently REROLL YOUR SOUNDTRACK does it similarly.

To reiterate, the music.xml file in the "content" folder should have the prefixed "Inner Sanctum" text before each track name, as I mentioned in a previous comment, and the music.xml file in the "resources" folder should remain as is, except for changing the root to the correct location after adding the "Inner Sanctum" folder.

As for the Lua file, I believe this is what its entire contents would look like:

InnerSanctumSoundtrack = RegisterMod("Inner Sanctum Soundtrack", 1) -- If you want to add each song title yourself, to automatically work with mods that display them local soundtrack = { "<SONG_NAMES_GO_HERE>", -- Basement "", -- Cellar "", -- Burning Basement "", -- Caves "", -- Catacombs "", -- Flooded Caves "", -- Depths "", -- Necropolis "", -- Dank Depths "", -- Womb/Utero "", -- Scarred Womb "", -- Blue Womb "", -- Sheol "", -- Cathedral "", -- Dark Room "", -- Chest "", -- Void "", -- Library "", -- Devil Room "", -- Angel Room "", -- Shop "", -- Arcade "", -- Secret Room "", -- Boss Defeated "", -- Challenge Fight "", -- Boss "", -- Boss (Alt) "", -- Boss (Mom) "", -- Boss (Mom's Heart) "", -- Boss (Isaac) "", -- Boss (Satan) "", -- Boss (The Lamb) "", -- Boss (???) "", -- Boss (Hush) "", -- Boss (Ultra Greed) "", -- Boss (Delirium) "", -- Boss (Mega Satan) "", -- Devil Room Find "", -- Angel Room Find "", -- Secret Room Find "", -- Treasure Room Entry 1 "", -- Treasure Room Entry 2 "", -- Treasure Room Entry 3 "", -- Treasure Room Entry 4 "", -- Challenge Entry "", -- Challenge Outro "", -- Boss Intro "", -- Boss Death "", -- Boss Death (Alt) "", -- Boss Death (Hush) "", -- Utero "", -- Downpour "", -- Dross "", -- Mines "", -- Ashpit "", -- Mausoleum "", -- Gehenna "", -- Corpse "", -- Home "", -- Mineshaft Ambient "", -- Mineshaft Escape "", -- Planetarium "", -- Secret Room (Alt) "", -- Secret Room (Alt Alt) "", -- Boss Rush "", -- Boss Rush Start "", -- Boss Defeated (Twisted) "", -- Mom's Shadow Intro "", -- Strange Door "", -- Echoes Reverse "", -- Boss (Alt Alt) "", -- Boss (Mother) "", -- Dogma Intro "", -- Boss (Dogma) "", -- Boss (Beast) "", -- Boss Death (Alt Alt) "", -- Boss Mother Death "", -- Boss Dogma Death "", -- Boss Beast Death "", -- Downpour (Reversed) "", -- Dross (Reversed) "", -- Genesis (Reversed) "", -- Game Over (Jingle) "", -- Game Over "" -- "Boss (Hush Phase 1)" } InnerSanctumSoundtrack:AddCallback(ModCallbacks.MC_POST_GAME_STARTED, function() if SoundtrackSongList then AddSoundtrackToMenu("Inner Sanctum") -- This is also required only if you want to add the titles yourself if WhatsThatSong then WhatsThatSongAPI:AddSoundtrack("Inner Sanctum", soundtrack) end end end)
Last edited by AceHand; 26 Nov, 2024 @ 1:42pm
Hengus McMann  [developer] 26 Nov, 2024 @ 2:28pm 
This is a *massive* help, holy cow
I definitely scratched on this but couldn't figure it out, it genuinely warms my heart to see people so consistently dedicated to helping me out
Hengus McMann  [developer] 26 Nov, 2024 @ 3:31pm 
IT WORKS! Thank you so much! I'm gonna do some playtesting to iron anything out I'm missing but thank you all for the help!
ohlordhebacc 27 Nov, 2024 @ 4:17pm 
forgot to mention this (sorry): in the music.xml in the "content" folder, the name definition for the womb has to be
name="Inner Sanctum Womb/Utero"
otherwise it'll not play properly with soundtrack menu. the name definition for utero doesn't have to be changed
Hengus McMann  [developer] 29 Nov, 2024 @ 12:17pm 
Good to know! I'll patch that up real quick
< >
Showing 1-11 of 11 comments
Per page: 1530 50