Jean/party mode pull request #336

achimmihca · 2022-11-04T11:09:02Z

What does this PR do?

Implement party modes.

Current approach:

Party Mode has two options: "Teams" and "Free for All".

Currently "Teams" isn't working, although the UI has been started.
"Free for All" will work to automatically create rounds to match and make all added users play.
Eventually it would be nice to have a tournament mode for the "Free for All" mode, so that winning players are matched against each others, until there is only one winner.

"Free for All" will only work if there are exactly two microphones enabled - support for more players/microphones needs to be added.

The flow works as follow:
- Participants can be added, either using existing Player Profiles, or entering new guest names through text fields
- Based on the number of participants, the number of rounds will be calculated
- Song selection can be manual, one random song, or a subset of random songs so that users have a bit more choices
    - in team mode, we should let users from each team to choose the song in turns
    - there is an infinite joker button that will reselect (a) new song(s), eventually the number of joker per player/teams should be modifiable (including an "infinite" value)
- For each round, users can define:
    - the winning condition (still work in progress, only the highest score will properly work)
    - a game modifier that will alter the gameplay based on a condition
- A "Versus" screen shows the randomly matched players, as well as the winning condition and modifiers for the round, if any
- Once the song ends, the "Versus" screen is shown again for the next round

Additional Notes

@jean-moreno this is a draft PR for your branch such that I can review and give feedback.
I created a new branch for the PR. Thus, you can continue development on your original branch and when ready, merge it to this branch.

Audio being mandatory, it makes more sense to output an error since the song won't work at all.

The custom control shows the selected flag, or "Mixed Values" or "None" if relevant, and selection happens in a custom dialog showing all possible options as toggles.

Party Mode has two options: "Teams" and "Free for All". Currently "Teams" isn't working, although the UI has been started. "Free for All" will work to automatically create rounds to match and make all added users play. Eventually it would be nice to have a tournament mode for the "Free for All" mode, so that winning players are matched against each others, until there is only one winner. "Free for All" will only work if there are exactly two microphones enabled - support for more players/microphones needs to be added. The flow works as follow: - Participants can be added, either using existing Player Profiles, or entering new guest names through text fields - Based on the number of participants, the number of rounds will be calculated - Song selection can be manual, one random song, or a subset of random songs so that users have a bit more choices - in team mode, we should let users from each team to choose the song in turns - there is an infinite joker button that will reselect (a) new song(s), eventually the number of joker per player/teams should be modifiable (including an "infinite" value) - For each round, users can define: - the winning condition (still work in progress, only the highest score will properly work) - a game modifier that will alter the gameplay based on a condition - A "Versus" screen shows the randomly matched players, as well as the winning condition and modifiers for the round, if any - Once the song ends, the "Versus" screen is shown again for the next round

achimmihca · 2022-11-14T11:52:21Z

A GIF to show current state.

achimmihca · 2022-11-14T14:02:28Z

UltraStar Play/Assets/Common/Model/Setting/PartyModeSettings.cs

+public enum EPartySongSelection
+{
+    RandomSong, // a random song is picked
+    RandomSubset, // a random subset of songs is picked, and players choose which one to sing


Nice idea. Playlists could be reused as user created subsets.

Players should be able to define which subsets qualify for the random selection

achimmihca · 2022-11-14T14:04:37Z

UltraStar Play/Assets/Common/Model/Sing/SingModifier.cs

+    {
+        public enum ETriggerType
+        {
+            Infinite,


Better call it Always ?

"When does it trigger" => Always

achimmihca · 2022-11-14T14:05:40Z

UltraStar Play/Assets/Common/Model/Sing/SingModifier.cs

+            Infinite,
+            AfterTime,
+            UntilTime,
+            TimeRange,


"When does it trigger" => InTimeRange ?

Or just TimeRange, I am not sure, whatever

achimmihca · 2022-11-14T14:07:26Z

UltraStar Play/Assets/Common/Model/Setting/PartyModeSettings.cs

+{
+    RandomSong, // a random song is picked
+    RandomSubset, // a random subset of songs is picked, and players choose which one to sing
+    PlayersChoose // players choose the song


The other values use a noun at the end. Thus, I'd suggest PlayerChoice or just Manual.

achimmihca · 2022-11-14T14:15:56Z

UltraStar Play/Assets/Common/Model/Setting/PartyModeSettings.cs

+
+// TODO use this to filter the randomly selected songs
+[Flags]
+public enum EPartySongFiltering


It should be possible to select one or more values for each EPartySongFiltering

How to combine multiple values?

Probably any value of selected category, but every selected category at least one.

For example, two artists and one genre selected => all songs of the genre that are performed by one of the artists?

The question is, how can users select sets of songs?

Maybe this needs a different data structure, e.g. a list of song-lists. And each song-list is filled by a song search.

Example: User searches for green day, then has a button to add all found songs as song-list. User searches for 1990<=Year&&Year<=1999, then again adds all found songs as song-list.

achimmihca · 2022-11-14T15:31:31Z

UltraStar Play/Assets/Scenes/SongSelect/SongSelectSceneControl.cs

@@ -84,6 +87,9 @@ public static SongSelectSceneControl Instance
    [Inject(UxmlName = R.UxmlNames.songIndexButton)]
    private Button songIndexButton;

+    [Inject(UxmlName = R.UxmlNames.buttonJoker)]
+    private Button buttonJoker;


It is a button, should be called jokerButton. In general, most defining stuff at the end of the name.

achimmihca · 2022-11-14T15:35:19Z

UltraStar Play/Assets/Scenes/SongSelect/SongRoulette/SongRouletteControl.cs

@@ -93,6 +94,19 @@ private SongMeta SelectedSongMeta

    private void Start()
    {
+        Selection.Subscribe(selection =>


What are you trying to achieve? I think the coroutine is not needed

For example, UniRx has methods to do stuff when the value has been stable some time ( search .Throttle( )

achimmihca · 2022-11-14T15:36:25Z

UltraStar Play/Assets/Scenes/SingingResults/SingingResultsSceneControl.cs

+        if (sceneData.IsPartyMode)
+        {
+            // TODO intermediary scene that sums up all the rounds after last round
+            SceneNavigator.Instance.LoadScene(PartyModeManager.CurrentRoundData.isLastRound ? EScene.MainScene : EScene.PartyModeVersus);


The proper target scene should be selected directly from SingScene instead of redirecting here.

achimmihca · 2022-11-14T15:38:36Z

UltraStar Play/Assets/Scenes/Sing/SingSceneControl.cs

@@ -274,8 +295,230 @@ private void Start()
        {
            timeBarControl?.UpdateTimeValueLabel(songAudioPlayer.PositionInSongInMillis, songAudioPlayer.DurationOfSongInMillis);
        }));
+
+        // Modifiers apply callbacks
+        foreach (SingModifier modifier in sceneData.SingModifiers)


There is naturally quite a lot new logic in this class. I'd suggest to create a dedicated PartyModeControl for it. SingSceneControl can then delegate to this.

achimmihca · 2022-11-14T15:41:16Z

UltraStar Play/Assets/Scenes/PartyMode/PartyModeVersus/PartyModeVersusControl.cs

+// Disable warning about fields that are never assigned, their values are injected.
+#pragma warning disable CS0649
+
+// Scene that shows before a round in Party Mode


I think this is a good idea. Players can prepare, change mics, etc. in this scene.

However, maybe this could be combined with the round results?

After each round, the results are shown AND next players can prepare. I don't think we need a dedicated scene for this.

achimmihca · 2022-11-14T16:04:24Z

Thanks for your work!

I still have some conceptual doubts for the party modes.

Team vs free-for-all

I my opinion "Free for all" is a special case of "Teams", namly every player is his/her own team.
- Thus, I suggest to always show configuration for teams. A simple "Free for all" button could move each player to his/her own team.

Eventually it would be nice to have a tournament mode for the "Free for All" mode, so that winning players are matched against each others, until there is only one winner.

A knock-out system is a neat idea.
However, you could do the same with teams (until there is only one winning team). Again, I think "free for all" should be treated as a special case of "teams".

PlayerProfiles vs. guest user names

IMO there should not be guest user names. If needed, users can define generic PlayerProfiles named guest1, guest2, or player1, player2 etc.
- PlayerProfiles also define difficulty, avatar, mic assignment.
- Introducing some guest data structure (even if it is only a string) messes with existing abstractions and user experience ("where can I adjust guest difficulty?", "Where can I change your picture?", etc.).
- IMO, having a single solution to add players simplifies things for devs and users.

Round count vs. player count

Based on the number of participants, the number of rounds will be calculated

This should be separated. 5 people may want to play 3 rounds.

Song selection from subset of songs

See my comment above:

The question is, how can users select sets of songs?
A song search UI could be created that allows users to add found songs as subset for random song selection.
- For example, user searches by artist "green day" and adds all found songs. Or user searches by year, language, etc. and adds all found songs. A search UI like in Advanced search UI, add an option to have sublevels for Artists / Folders / Editions / Years / Genre #325 could be reused
For now, I would skip random song selection from user defined subsets.

Versus scene vs. round result scene

I think these can be combined in a single scene: show current results after each round and tell users to prepare for next round.

Translations

I would not bother with translations until the concepts and UI have been finalized

achimmihca · 2022-11-14T16:10:28Z

"Multiple values" => We should implement some chips component to select multiple values. It should be visible, which values have been selected.

achimmihca · 2022-11-14T16:12:04Z

The party settings UI need some description text field, for example to explain win conditions.

achimmihca · 2023-01-16T08:46:43Z

I took inspiration from this PR, but implemeted a new UI for party mode configuration.

I want to include these party modes in the upcoming Steam release.
For now, I did the implementation in a private repository.

Thus, I consider this PR obsolete and will not merge it.

basisbit · 2023-01-17T01:28:05Z

Thus, I consider this PR obsolete and will not merge it.

I suggest trying to find a way of allowing contributions get merged while you have your fork with features that you keep private for now.

achimmihca · 2024-06-28T13:02:46Z

I will close this as obsolete after #433.

@jean-moreno feel free to create a new ticket if you have further feature requests.

jean-moreno and others added 11 commits October 27, 2022 16:00

SongMetaManager: log error instead of warning when loading audio fails

9695875

Audio being mandatory, it makes more sense to output an error since the song won't work at all.

Sing Scene: added black fade in when starting sing scene

181ecd3

ObjectUtils: added function to shuffle a list

27cdbff

.editorconfig: force brace on next line for switch case blocks

2e1d0ca

Song Roulette: apply class to selected item to highlight it

dae2be9

VisualElementExtensions: added method to add an element next to another

afd3a1d

Added custom UI controls to select Enum Flags

cb09144

The custom control shows the selected flag, or "Mixed Values" or "None" if relevant, and selection happens in a custom dialog showing all possible options as toggles.

Main Styles: added variable for default button radius

991b6a8

Added data classes to be used with Party Mode

ab0df29

added new scenes to the build settings

b438269

achimmihca commented Nov 14, 2022

View reviewed changes

achimmihca closed this Jun 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Jean/party mode pull request #336

Jean/party mode pull request #336

achimmihca commented Nov 4, 2022

achimmihca commented Nov 14, 2022

achimmihca Nov 14, 2022

achimmihca Nov 14, 2022

achimmihca Nov 14, 2022

achimmihca Nov 14, 2022

achimmihca Nov 14, 2022

achimmihca Nov 14, 2022

achimmihca Nov 14, 2022

achimmihca Nov 14, 2022

achimmihca Nov 14, 2022

achimmihca Nov 14, 2022

achimmihca commented Nov 14, 2022 •

edited

Loading

achimmihca commented Nov 14, 2022 •

edited

Loading

achimmihca commented Nov 14, 2022

achimmihca commented Jan 16, 2023 •

edited

Loading

basisbit commented Jan 17, 2023 •

edited

Loading

achimmihca commented Jun 28, 2024

Jean/party mode pull request #336

Jean/party mode pull request #336

Conversation

achimmihca commented Nov 4, 2022

What does this PR do?

Additional Notes

achimmihca commented Nov 14, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

achimmihca commented Nov 14, 2022 • edited Loading

achimmihca commented Nov 14, 2022 • edited Loading

achimmihca commented Nov 14, 2022

achimmihca commented Jan 16, 2023 • edited Loading

basisbit commented Jan 17, 2023 • edited Loading

achimmihca commented Jun 28, 2024

achimmihca commented Nov 14, 2022 •

edited

Loading

achimmihca commented Nov 14, 2022 •

edited

Loading

achimmihca commented Jan 16, 2023 •

edited

Loading

basisbit commented Jan 17, 2023 •

edited

Loading