Smash Ultimate Soundtrack

Below this # is all the information from Kyle's OriginalSoundtrack mod. Much appreciation for setting this soundtrack foundation up for my use!

Having listened to the entire Smash Ultimate soundtrack, I decided to create a appropriate soundtrack using Smash Ultimate for Risk of Rain 2. While subjective to my music taste, I wanted to make a soundtrack that fits each scenario in Risk of Rain 2 correctly. Here are the rules I tried to follow:

1) Each scenario must have at least 4 songs total
1.a) A typical stage has 2 boss songs and 2 stage songs.

2) Each scenario must have different series in its playlist
2.a) The exception is stage 1 (composed of only Smash series songs), outro, intro, splash (hopoo games), vocal songs, and lobby (character select).

3) Almost every song is extended. The majority of songs are less than 3 minutes, making the looping of the intros for songs annoying. 

4) Almost every series in Smash Ultimate is included. A couple of series were just too tough to find a spot
4.a) Left out series (that I can remember): Rob, Game and Watch, Duck Hunt, Wii Fit (technically)

5) Every song is used once, except vocal songs since they may come in English and Japanese

I tried to follow themes and references when I can. None of this music I own and is used only for entertainment purposes. The icon.png I do not own as well. I made small changes in ## Scene IDs to stay relevant with the current update of Risk of Rain 2. Feel free to turn the "loop" setting off (by setting it to "false" in settings.xml) and adjust the volume however you wish.

Lastly, this is my first full programming project. While it is not much, I want to start somewhere. So thank you for my friends and family who got me far enough to make this. Also, particular thanks to Evolvez_YT to finalize these tracks.

And Thank You,

Zem

The OriginalSoundTrack Plugin

This mod allows you to play Risk of Rain 1 (or any) music in place of the normal soundtrack.

You must supply your own music files though.

Place the DLLs and settings.xml in: Risk of Rain 2\BepInEx\plugins\OriginalSoundTrack

Your music files can either go in the same directory or you can specifiy a directory in settings.xml (using the <music-path> tag).

Music files can be in .mp3 or .wav format (with those exact extensions).

Make sure the filenames match what's in settings.xml (or edit settings.xml to match your files.)

If you delete settings.xml, don't match your filenames with <song> tags, or delete all <song> tags, then the plugin will just choose random music it found.

settings.xml

If your files match all the song "names", then you don't need to do anything else, but feel free to customize.

If the plugin fails to match a song for a scene, it will just choose a random one it found in the plugin directory.

Put scene IDs in the "scenes" attribute to have audio play on that scene in settings.xml. The scenes attribute is comma separated. A scene only has to be "contained" in the real scene ID for it to match: ("golemplains" in the scene attr will match for the golemplains2 scene id.)

Example for playing MyFile.mp3 on the title screen and main menus:

<song
    name="MyFile.mp3"
    scenes="title,lobby,logbook,crystalworld,eclipseworld"
    boss="false"
    volume="1"
/>

Setting boss to "true" means that music can only play when the player activates the teleport on a level (or on the final boss fight). Otherwise music can only play elsewhere (non teleport events). "volume" is a decimal between 0 and 1.

It's ok to have multiple <song> definitions with the same name or scenes. The plugin will choose a song randomly among the matching songs.

The top level <volume> tag is the master volume for all this plugin's music. Again, a decimal between 0 and 1.

The top level <loop> tag determines if music should loop or pick another song (from matching songs) after a song ends.

The top level <music-path> tag specifies where the plugin should scan for music. It does not traverse down directories. The default path it scans for music is: Risk of Rain 2\BepInEx\plugins\OriginalSoundTrack

Scene IDs (level IDs).

(As of the 1.0 update)

See here for pictures of the level scenes: https://riskofrain2.fandom.com/wiki/Environments

Non Levels:

ID                 Description
===============================================
splash         -   "hopoo games" image
intro          -   intro cutscene
outro          -   outro cutscene
title          -   the title screen
lobby          -   the select character screen.
logbook        -   view logs screen.
crystalworld   -   prismatic trials menu (not normally reachable in modded RoR2)
eclipseworld   -   eclipse menu

Levels:

ID                 Level Name / Description
===============================================
bazaar         -   Bazaar Between Time (The Shop)
blackbeach(2)  -   Distant Roost
golemplains(2) -   Titanic Plains
snowyforest    -   Siphoned Forest
foggyswamp     -   Wetland Aspect
goolake        -   Abandoned Aqueduct
ancientloft    -   Aphelian Sanctuary
frozenwall     -   Rallypoint Delta
wispgraveyard  -   Scorched Acres
sulfurpools    -   Sulfur Pools
dampcavesimple -   Abyssal Depths
shipgraveyard  -   Siren's Call
rootjungle     -   Sundered Grove
skymeadow      -   Sky Meadow
moon2          -   Commencement (Final Level)

artifactworld  -   Bulwark's Ambry (Artifact Challenge arena where you unlock the artifacts with keys.)
arena          -   Void Fields (poison area with lots of "teleport" events.)
mysteryspace   -   A Moment, Fractured (the place where you can obliterate yourself.)
limbo          -   A Moment, Whole (the mega scavenger boss)
goldshores     -   Glided Coast (the place where you fight the golden Stone Titan)
voidstage      -   Void Locus (4 void cells and then go to Planetarium to fight Voidling boss)
voidraid       -   Planetarium (Fight oversized purple mutated crab)

itancientloft  -   Simulacrum version of stage
itdampcave     -   Simulacrum version of stage 
itfrozenwall   -   Simulacrum version of stage
itgolemplains  -   Simulacrum version of stage
itgoolake      -   Simulacrum version of stage
itmoon         -   Simulacrum version of stage
itskymeadow    -   Simulacrum version of stage

Other Info

This plugin uses NAudio.dll https://github.com/naudio/NAudio to help load and play music at runtime. This is done to make it very easy for players to supply their own music. The downside is that the normal in game music isn't disabled (Maybe there is a way to do that, I dunno). To get around this, this plugin sets your in game music volume setting to 0. It tries to set it back to where it was when the game closes but I'm not sure if this works. Anyway you have been warned.

Licence

When applicable, assume stuff is under the MIT licence ( https://opensource.org/licenses/MIT ) I am not liable for any damages and there is no warranty etc...

CHANGELOG

[1.3.1] - 2023-1-30

I lied, I forgot to include full simulacrum support...here.

[1.3.0] - 2023-1-30

CHANGELOG.md added. Added 2 tracks. Prismatic trials, the logbook, and the simulacrum screen have music adjustments. Full simulacrum support. Future updates are undecisive now. If they come, it will include volume changes and a couple more tracks.

[1.2.0] - 2023-1-30

Fixed errors that did not allow particular tracks to play. All tracks now play correctly.

[1.1.0] - 2023-1-29

Fixed errors that did not allow particular tracks to play. Adjusted volume.

[1.0.0] - 2023-1-27

Mod release.