Robust Music Manager B:150

[PerfectTangent]

Description

Unitystation has need of a better system for managing, playing, and adding new songs to the game.

song triggers:

• in the lobby (local)
• on spawn (local, job specific)
• on round start
• during boss fights (local)
• admin triggered songs (global)
• location triggered songs (lavaland, maintenance, etc.)
• randomly played music. Possibly even contextual music playing, such as playing particular tracks in low light conditions or when in crit. (local)
• during in game events, such as when the nuke has been primed and during the aurora caelus event (sometimes global, sometimes local)
• from the jukebox and other in game devices. (diagetic)
• when a particular song must end for another one that is overriding it (such as when an admin triggers a global sound), the music manager must fade out the music.

What is needed to fulfill the bounty:

• [ ] create a music manager and tools following the specifications described.
• [ ] refactor music, ambient tracks, and the jukebox to use addressables and ensure that server hosts can add their own music to the game.

Design Notes:

• Songs will be played either locally, globally, or diagetically. Global songs probably should override local songs. Perhaps a scoring system could be devised; when 2 songs are triggered to play, their scores are compared, and the song with the higher score overrides.
• this system needs to be compatible with addressables, and server hosts should be able to easily add and remove songs from jukebox, lobby music, and admin music library. The goal is to make it as easy as possible for server hosts to configure their own music for their servers.
• structurally, it may be best to have a SoundAmbientManager that the music manager and other scripts can poke to play music at particular moments, and occasionally at random if nothing else is playing.
• the triggers for randomly played music could potentially be incredibly mundane, like a 1% chance when a person turns on a microwave to play a chef themed song. It may be best to have triggers point to scriptable objects which can be organized in a single place in the repository and could also define the % chance of the song playing in a given circumstance.

The goal of this system is not to make music something that is constantly heard throughout the play experience. It is meant to provide a flexible music playing experience. The best system would allow a player to be able to enable, disable, and control the volume of all music in the game. This is especially crucial to prevent abuse, such as by admins getting too trigger happy with the global sound player (seen it happen before).

This issue should not be considered a complete covering of what is needed. More discussion should probably be had as it is being worked on to ensure the manager is giving the desired effect and atmosphere we want.

[Pockets-byte]

I've seen several songs that would be good for various situations sutch as songs that would work for near, and far spacewalks, the singularity being loose, and general life on the station this is also going to go a long way for playability, as good music almost doubles how good a game is. take FTL for example, without the music you get bored from the repetitiveness of making runs

[pyrosshade]

What of certain situational songs only available during certain alert levels?

[Pockets-byte]

sounds like a good idea, IE a delta alert song/songset, and maybe a change in ambience for various alert levels?

[PerfectTangent]

this issue is being promoted to bounty status, valued at 150 USD.

[JustinTrotter]

I'll pick this up.

https://github.com/JustinTrotter/unitystation/tree/robustAudio

[PerfectTangent]

@JustinTrotter how is this coming along? Are you in a rut with anything?

[JustinTrotter]

@JustinTrotter how is this coming along? Are you in a rut with anything?

Hello. Sorry Ive been busy with work related project for the past two months. It finally released last night so I should have more time now to work on this.