zeddevstuff/ukmusicreplacement

Ultrakill mod allowing users to use custom songs in regular (non boss or special) levels

This mod is now archived and deprecated in favor of USTManager which should release anywhere between January 1st and 3rd (the repo will be private until then so the link won't get you anywhere)

Update: As of v0.8.0 (currently unreleased), no longer requires UKUIHelper to work

UKMusicReplacement

Ultrakill mod allowing users to use custom songs in regular (non boss or special) levels

Installation

To install, just unzip the release you downloaded in your BepInEx plugins folder (or "UKMM Mods" if you use UKMM). Download and install UKUIHelper for the mod to work. The releases contain a custom song named "Stolen Heaven" for 4-1 and 4-2 by triageGremlin, but if you build the mod yourself, it won't come with any song.

How to add custom songs

To add custom songs, open "CustomMusic" in the mod folder, create a folder with your song pack name then another one inside named with the number of the level you want to replace the music from (ie "4-1","1-2", nothing more, nothing less) and add your 2 songs, one must be named "clean" and the other "battle". They must be either an ogg, wav or mp3 file or they won't work.

Building

To build UKMusicReplacement, you can either use Visual Studio or Visual Studio Code and dotnet. When building is finished, you should have a dll file. To use it, just put it in a folder and put that folder in you BepInEx plugins folder or "UKMM Mods" folder if you use UKMM.

ukmusicreplacement's Issues

Question

Can we change cybergrind's music with the mod ? If so what shall I name the folder for it to work ?

new music for levels combines with the old one

How do i mute the old music and keep the new music?

Doesnt Work

the mod is in UMM MODS, i just moved the folders from example to custom music but they dont work, idk if i am using the wrong version of UMM or

Isn't recognizing the music

I made a folder for 4-1, 4-2 and 4-3 and the music isn't playing. I even changed songs and made sure they were ogg files but it just won't work.

2-1 music don't work

Hi, i traying to put custom music in 2-1 (ogg file), and when i go outside, the custom music don't work

Mod does nothing + is poorly explained

I followed all the necessary steps to replace the songs. I downloaded the mod, unzipped it, put the UKMusicReplacement folder in the UMM Mods folder, got the dependency and did the same for that, but the MR button doesn't exist no matter what i do.




also how was i supposed to know about the MR button when the only place it's mentioned is the github issues instead of the actual mod page?

levels with multiple clean and battle music

levels like 6-1 seems to have more than one battle music.

Where do i put the mod helper?

ive been trying for a while to get it to work, ive gotten it down to the exact example but i dont know what to do now, i noticed the mod helper is needed but idk where i put it

Mod loading but doesnt recognize the music

I installed the mod using UMM (Ultra Mod Manager) and when I select the level in the MR menu nothing shows up