ZPMods' The Playlist Mod

ZPMods' The Playlist Mod allows you to create custom albums for Risk of Rain 2 and replace the music tracks for you own. As well as switch between your created albums or Chris Christodoulou's original soundtrack without having to swap out mods.

The mod comes with Feather's album, Eternal, as both a collaboration with ZPMods and a template for you to base your album on.

You have to put your own audio files in order to use them in game and put them in a folder containing a album.xml file.

The mod supports .wav files and .mp3 files.

The album.xml file

Be sure to give your album a unique custom name, if multiple album share the same name it might not work as expected.

If you want to customize your album's appearance on the Playlist Menu, you must provide a Display Name node, an description node and/or an icon node.

Example :

<!-- Used on the album name display in the pause menu -->
<displayName>Feather - Eternal</displayName>
	
<!-- Used on the album name display in the pause menu -->
<description>The playlist mod's official sound track.</description>

<!-- The name of the icon file in .png format -->
<icon>FEATHER_artwork.png</icon>

Some additionnal settings for your album includes the volume multiplier which serves to reduce the music tracks' volume in case they might be too loud.

And repetition prevention modes, in case you might want to prevent your album from playing the same tracks over and over.

<!-- Album volume multiplier in percentages, 50 is half the regular volume and so on -->
<volume>60</volume>	
	
<!-- If not empty, the mod tries to avoid repeating tracks if multiple tracks are available -->
<!-- Use "Levels" to prevent from a level to another, use "Bosses" to prevent between bosses and use "NextTrack" to prevent from a track to another -->
<preventRepetitionMode>Bosses</preventRepetitionMode>

You should have a list of song attributes that list every song in the album as well as the scenes they should be played on.

If your audio files names match the song names your tracks should play normally.

Be sure to change the scenes list and the boss value.

The track's display name is only used on the pause menu's track info popup.

Example :

<song
	name="Blood is heat boss version.wav"
	displayName="02 - Blood is Heat"
	scenes="shipgraveyard,snowyforest,frozenwall,dampcavesimple,wispgraveyard,rootjungle,blackbeach,golemplains"
	boss="true"
/>

Or :

<song
	name="FEATHER_03_Soul Shaft.wav"
	displayName="03 - Soul Shaft"
	scenes="snowyforest"
	boss="false"
/>

Scene IDs

As of now the scene IDs can be found here : https://risk-of-thunder.github.io/R2Wiki/Mod-Creation/Developer-Reference/Scene-Names/

Disclaimer

The mod uses NAudio to play the custom tracks. While it helps a lot, some features like the High Filter Pass on the boss tracks and the dynamic output device selection do not work as intended. So if you plug/unplug your audio output device, you might encounter some unintended effects.

Thanks

Many thanks to the Risk of Rain 2 Modding discord server. Especially dgosling and iDeathHD.

Thanks to Kyle's Original Sound Track mod for the inspiration and doing most of the base work. Thanks to EtiTheSpirit for his fix of the Original Sound Track mod, which helped a lot.

And last but not least, huge thanks to our friend and partner, Feather, for letting us use his album Eternal as the official sound track of this mod.

Licence

When applicable, assume your tracks are under the MIT licence ( https://opensource.org/licenses/MIT ) ZPMods is not responsible for any misuse, damage or legal repercussions...