Modding > Spelunky 2 > Custom Music Mod
Details
Disclaimer: this mod is an improvement to the "Custom Music Engine" from @JackHasWifi , as it fixes a lot of bugs and adds some features.
This was done by @Haon607 and @GukstFeatures and instructions:
With this mod you can customize the music in Adventure mode!
To add your custom music tracks, go in the mp3 folder and replace the dummy .mp3 files with your own. (length does not matter)
Lowers music volume while in a background layer.
Works in Online Multiplayer (minor bugs; see below)This mod supports all areas including;
duat (_duat)
city of gold (_cog)
basecamp (_base)
menu screen (_menu)
NPC aggro music (_shop_aggro)
all dark variations (files with _dim at the end)
and all bosses (files with _boss at the end)Does NOT yet support things like Shop and Black Market!
Bugs:
_shop_aggro music keeps playing untill the end of the layer, even though the NPC is dead.
There is no option to customize the shop music. (layer music keeps playing)
Causes an Error when player is crushed. (does not affect singleplayer)Multiplayerbugs:
Music keeps looping although it should not. (Can be fixed by making a new lobby or restarting the game; Variation of this Bug can be fixed by triggering a music change)
If you quit an online game, the music of the last area may keep playing untill you start a new run.
Music volume is lowered for everyone when the "first player" (originally lobby creator) is in a background layer, and does not lower when somebody else enters a background.
"first player" will be changed to another person when they get crushed.Version 1.1.1:
Fixed Bug: Didn't play music in 1-4 darkVersion 1.1.2:
Fixed Bug: Didn't play music in dark COVersion 1.1.3:
sound effects are no longer overwrittenIf you want to report a bug or have improvement ideas leave them in the comments, alternatively look for us on the Spelunky Discord servers (Haon607#haon607 / gukst#gukst)
Downloads
Latest Download
| Downloads | Name | Uploaded | |
|---|---|---|---|
| 273 | custom_music_mod_v1.1.3.zip | 1 year, 5 months ago |
Past Downloads (3)
| Downloads | Name | Uploaded | |
|---|---|---|---|
| 348 | custom_music_V1.1.2.zip | 2 years, 10 months ago | |
| 7 | custom_music_V1.1.1.zip | 2 years, 10 months ago | |
| 73 | custom_music_V1.1.zip | 2 years, 11 months ago |
Comments (22)
Please log in to leave a comment.
@Gukst I added you on Discord, I may have additions for your mod. Last week I was tinkering with JackHasWifi's mod and only now found this. My tinkerings would add shop music (a single music file by detecting whether player is in shop), several tracks for menu states and support for multiple tracks per area. Thanks.
dark CO?
Does anyone else crash at the end of an online run once everyone dies?
In the future, would it be possible to have it be able to pick from a selection of tracks instead of just one? Like how Mines in HD had 4 different normal tracks
There seems to be some bug with this mod currently that causes your game to crash everytime your team dies in online.
Thanks! Downgrading versions fixed the overlaid song issue, and the songs that didn't work were on my end because I accidentally converted the file type for those ones incorrectly.
@Accracy we are currently unsure what causes this error, try installing it again or installing it manually. If that doesn't work you could use an older Version or try coping the soundbank file from an older version in the newest version. If we find a solution or are able to reproduce this error then i will come back to you.
I've had this mod for a while now and updated to the latest version and I had to relist all of my songs. Now some songs don't work (volcana, volcana_dim, olmec, tide, temple, cog, neo, and neo_dim), and the original game's songs are overlaid with the one's that I've added.
I was going to use this in my game, but unfortunately it replaces the sound effects with the vanilla ones, is there a way to change the music and enable said changed music without getting rid of other sound effect mods?
I replaced the jungle theme with a song i got with a youtube to mp3 downloader, but when i get to the jungle the song doesnt play, and i get an error message. also, is it supposed to be silent in other areas i have yet to replace the files in?
So error minor error that'd was easy to fix manually. I wasn't getting music for Volcana and noticed the .mp3 was spelled _vulcana.mp3/_vulcana_dim.mp3, but in the lua script it's spelled correctly leading to it giving a line 120/254 error. So just switching the name fixes it.
@Haon607 Hey, the original Spelunky 2 music is still playing behind the custom track that I included. I made sure to replace the MP3 file, so I have no idea why this is happening.
@Haon607 Oh awesome thanks! Yep it has everything, makes it a lot less "shooting in the dark" when developing and hoping something sticks. @Gukst I'll msg you later today
@plow At this (https://spelunky-fyi.github.io/overlunky/#Overlunky-Playlunky-Lua-API) link, you can find a bit of documentation. I am not sure if there is everything in there you need.
Thank you for your enthusiasm! The thing is that we have little to no experience in working in a softwareproject, I would like to talk to you more about this, please contact me on discord gukst#6168
@Haon607 Hey I know it's been a long time since this was commented on, but do you know if there's a place for documentation of spelunky 2 properties or anything else (like THEME and ON in the main.lua)? New to spelunky 2 modding but not new to coding. Was planning on enhancing this since it doesn't seem too complex to add 2 things:
If I'm successful I would love to upload it with your guys' (you and Gukst) permission and/or JackHasWifi.
@vissarion of course. use it or change so that it suits your mod! Very kind of you to ask before.
Hi! Am I allowed to use this mod as a base to change music in my mod? With credit, of course.
@Sudux This is an amazing Idea. If we Implement that, we will probably make another mod with that feature. For now you could just add a 15 minute soundtrack with an intro at the start and then loops for the rest of the time. It isn't the best solution, but it works for now
@Haon607 Glad to hear it.
If you do update it, do you think it would be possible to give music "intros"? In other words, a unique sound file would play before the repeating sound file starts for each music track. That would allow a lot of music tracks to be implemented better.
@Sudux we are still figuring out if adding music for these areas is possible, but we have no time right now, but we are planing to do so if possible.
Do you plan to update this further at any point? Maybe allow us to add music for the black market, vlads castle, wet fur caves, mothership, and perhaps a separate title screen vs main menu music?