Easily change any sound (music, sound effects, dialogues, and more) in Neon White!
Supports MP3, WAV, OGG, AIFF and more. (everything that unity supports)
Warning
If you're a speedrunner, please read "Speedrunning".
When it comes to speedrunning, it's essential for leaderboard moderators to be able to hear what you're doing in a game. For example, if they can't hear the water boost sound effect, they can suspect that you got it from nowhere, thus rejecting your record. In short, if you're planning on submitting a record to the leaderboard, please make sure that NO gameplay sound effects (demon noises, gun sounds, water boost noise, wall-breaking noise, etc.) are being changed. You can check that by dragging the sound effects volume slider around. Game music, voices, level finish jingles, and more, are fine to have on video. Also, remember that someone will have to watch the video you're sending, so don't put weird NSFW or turbo bass-boosted sounds in there.
And... Sound Pack creators, please mention that the pack isn't suitable for speedrunning if that's the case... please and thank you.
Important
To change the properties you have to have MelonPreferencesManager installed.
How to change sounds?
The whole system is designed to be very easy to work with. If you're planning to change sounds, you have to turn on the melonloader console before launching the game. The console will display sounds that are currently played. For the sake of this tutorial, let's say we want to change the katana slash sound effect. How would we do that?
- Go to the
Mods/NeonSoundReplacerfolder and put a sound effect that you want to use later (switch the original one with). - Open the MelonPreferencesManager window, go into
Neon Sound Replacer Settings, selectLog Sounds, and remember to click theSave Preferencesbutton at the top. - Go into the game and trigger that sound effect (in that case the katana slash)
- Go into the console and look for the proper sound effect, you might want to trigger it a few times to check if that's the correct one. (mostly trial and error if you can't find it)
- The sound effects triggered by the game will look like this:
You now know that the sound effect in the game files is called WEAPON_KATANA_FIRE :D
- Now go into
Neon Sound Replacer Settingsand format the line like thisWEAPON_KATANA_FIRE = soundeffect.mp3. Remember to save preferences! - Close the window and trigger that sound again. If you hear a different sound effect, congrats :D If not, look in the console for potential errors.
How to change sound volume?
Since version 1.0.1, you can now specify a volume for each custom sound. To do that, go into Neon Sound Replacer Settings and format the line like this:
WEAPON_KATANA_FIRE = soundeffect.mp3 0.5
You can put any float value in there. That means values like 0.1 if you want to make the sound quieter, or 4 to make the sound 4 times louder. Remember to save preferences!
If you put a value higher than 1, the sound effect might get distorted. So be careful with that.
The custom sound effect is not working :(
Most of the time the issue lies in the formatting or the file having "weird" characters in the name. To fix that, change the name of the file to something simple. I highly suggst naming stuff without spaces and with basic latin characters (A-z + 0-9) such as: explosion01.mp3 or coolSoundEffect2.wav. Then remeber to reflect that change in the NeonSoundReplacer config.
If you still don't hear your sound effect, try to make your game a bit louder to see if maybe the sound itself is just quiet in comparison to the rest of the game.
If that didn't help you, consider asking for help in the #modding on NW Speedrunning Discord Server.
How to create sound packs?
If you finished changing the sounds, create a .txt file and paste all of the lines from Replace Sounds Here, and put it in a zip with all of the sound effects that you use. If you want to see a more practical example then download the OldDemoSoundPack in the featured section.
How to install sound packs?
Unzip the file and paste all lines that the pack creator provided in the Replace Sounds Here box. Grab all sound files from the zip and put them in Mods/NeonSoundReplacer.
There is a delay
If you notice a slight delay, edit the sound effect and remove the silence at the start. If that didn't help than try exporting files to .ogg instead of .mp3 or .wav. If you already did that then I can't help you more, unless I find a fix. The issue could be caused by your hard drive being slow, game lagging, etc. Since we're reading a file from disc every time the sound effect is played, it will be slower than loading it all at once (AssetBundles). I personally haven't had an issue even on my slower hard drive, so if you encounter that issue, either create a New Issue or DM me on discord @tuchan.
- Go to releases and download the
NeonSoundReplacer.dlland put it in your Mods folder
Note
If there is an update, you will see a pop-up in game.
Features music and level jingle found in the Neon White Demo.
If you don't plan on changing sound effects in that session and you want to launch your game faster, add --melonloader.hideconsole to launch properties (right-click the game on steam -> properties -> launch options at the bottom of that window) to hide the console that melonloader loads in.