Jukebox and sing mod: instead of always using the whole library, allow selecting a playlist and activate/deactivate shuffle (default for this mode should be active shuffle)

[franciscopassos]

Issue type: Feature request

Actual behaviour

The next song is drawn from the full library at random.

Expected behaviour

It should be possible to narrow it down to a playlist and then have this mode select songs at random from that playlist.

Implementation hints

No idea, sorry!

[achimmihca]

The next song is drawn from the full library at random.

Yes. Furthermore, the mod prefers songs from the song queue.

So one way to implement such a feature could be to add the songs of a playlist to the song queue in random order. But this would be unhandy to manage.

Proper implementation would be to accept a new mod option, e.g., a playlist name. If configured, the mod should use the songs of the playlist instead of the whole song list.

[franciscopassos]

Well, the mod activates the jukebox mode. When we are in the music selection list, if we filter the list to a single playlist, and then we start a song, technically we won't come back to select another song. We will select one after another.

So we could technically assume the filter from the selection IS the user intent for the filter for the whole singing session. At least until it is interrupted. It's a little more UX-friendly than having the playlist choice in the mod menu itself.

[achimmihca]

I see, good point.

Some implementation hints:

• the playlist from the song select can be found in NonPersistentSettings.PlaylistName
• the mod currently chooses a random song from all songs available. Therefore, GetNextRandomSongMeta calls songMetaManager.GetSongMetas().
  • Instead, PlaylistManager.GetSongMetas should be used if NonPersistentSettings.PlaylistName is set.

So, should be pretty simple to implement.
I will add it to next Melody Mania beta when I find time.

[franciscopassos]

That sounds perfect, thank you!

I was thinking about what you wrote:

Yes. Furthermore, the mod prefers songs from the song queue.

Is this the list that people can add to with their phone? Then that is really perfect!

The next song comes from the hand-picked queue if it is no empty and if it is empty, it gets a random one from the selected playlist. Super!

[achimmihca]

Instead, PlaylistManager.GetSongMetas should be used if NonPersistentSettings.PlaylistName is set.

I implemented this change in Melody Mania 1.5.2-beta1.
Will keep this issue open until the next reintegrate of Melody Mania into UltraStar Play.

[franciscopassos]

Sincere thanks!

I will give this a test at the end of the month (when I get back to my computer) and will report back.

[franciscopassos]

I just tested this on the beta branch and can confirm this is working well.
Sincere thanks Andreas!