Merge pull request #31260 from smoogipoo/multiplayer-free-style

Add support for "freestyle" in multiplayer

Author: peppy

osu.Game.Tests/Visual/Multiplayer/TestSceneMultiplayerMatchSongSelect.cs

@@ -60,14 +60,15 @@ private void load(GameHost host, AudioManager audio)
 
         private void setUp()
         {
-            AddStep("reset", () =>
+            AddStep("create song select", () =>
             {
                 Ruleset.Value = new OsuRuleset().RulesetInfo;
                 Beatmap.SetDefault();
                 SelectedMods.SetDefault();
+
+                LoadScreen(songSelect = new TestMultiplayerMatchSongSelect(SelectedRoom.Value!));
             });
 
-            AddStep("create song select", () => LoadScreen(songSelect = new TestMultiplayerMatchSongSelect(SelectedRoom.Value!)));
             AddUntilStep("wait for present", () => songSelect.IsCurrentScreen() && songSelect.BeatmapSetsLoaded);
         }
 

osu.Game.Tests/Visual/Multiplayer/TestSceneMultiplayerMatchSubScreen.cs

@@ -30,6 +30,7 @@
 using osu.Game.Screens.OnlinePlay.Match;
 using osu.Game.Screens.OnlinePlay.Multiplayer;
 using osu.Game.Screens.OnlinePlay.Multiplayer.Match;
+using osu.Game.Screens.OnlinePlay.Multiplayer.Match.Playlist;
 using osu.Game.Screens.OnlinePlay.Multiplayer.Participants;
 using osu.Game.Tests.Beatmaps;
 using osu.Game.Tests.Resources;
@@ -271,7 +272,10 @@ public void TestNextPlaylistItemSelectedAfterCompletion()
 
             AddUntilStep("last playlist item selected", () =>
             {
-                var lastItem = this.ChildrenOfType<DrawableRoomPlaylistItem>().Single(p => p.Item.ID == MultiplayerClient.ServerAPIRoom?.Playlist.Last().ID);
+                var lastItem = this.ChildrenOfType<MultiplayerQueueList>()
+                                   .Single()
+                                   .ChildrenOfType<DrawableRoomPlaylistItem>()
+                                   .Single(p => p.Item.ID == MultiplayerClient.ServerAPIRoom?.Playlist.Last().ID);
                 return lastItem.IsSelectedItem;
             });
         }

osu.Game.Tests/Visual/Multiplayer/TestSceneMultiplayerParticipantsList.cs

@@ -308,6 +308,33 @@ public void TestUserWithMods()
             AddStep("set state: locally available", () => MultiplayerClient.ChangeUserBeatmapAvailability(0, BeatmapAvailability.LocallyAvailable()));
         }
 
+        [Test]
+        public void TestUserWithStyle()
+        {
+            AddStep("add users", () =>
+            {
+                MultiplayerClient.AddUser(new APIUser
+                {
+                    Id = 0,
+                    Username = "User 0",
+                    RulesetsStatistics = new Dictionary<string, UserStatistics>
+                    {
+                        {
+                            Ruleset.Value.ShortName,
+                            new UserStatistics { GlobalRank = RNG.Next(1, 100000), }
+                        }
+                    },
+                    CoverUrl = @"https://osu.ppy.sh/images/headers/profile-covers/c3.jpg",
+                });
+
+                MultiplayerClient.ChangeUserStyle(0, 259, 2);
+            });
+
+            AddStep("set beatmap locally available", () => MultiplayerClient.ChangeUserBeatmapAvailability(0, BeatmapAvailability.LocallyAvailable()));
+            AddStep("change user style to beatmap: 258, ruleset: 1", () => MultiplayerClient.ChangeUserStyle(0, 258, 1));
+            AddStep("change user style to beatmap: null, ruleset: null", () => MultiplayerClient.ChangeUserStyle(0, null, null));
+        }
+
         [Test]
         public void TestModOverlap()
         {

osu.Game/Localisation/MultiplayerMatchStrings.cs

@@ -24,6 +24,21 @@ public static class MultiplayerMatchStrings
         /// </summary>
         public static LocalisableString StartMatchWithCountdown(string humanReadableTime) => new TranslatableString(getKey(@"start_match_width_countdown"), @"Start match in {0}", humanReadableTime);
 
+        /// <summary>
+        /// "Choose the mods which all players should play with."
+        /// </summary>
+        public static LocalisableString RequiredModsButtonTooltip => new TranslatableString(getKey(@"required_mods_button_tooltip"), @"Choose the mods which all players should play with.");
+
+        /// <summary>
+        /// "Each player can choose their preferred mods from a selected list."
+        /// </summary>
+        public static LocalisableString FreeModsButtonTooltip => new TranslatableString(getKey(@"free_mods_button_tooltip"), @"Each player can choose their preferred mods from a selected list.");
+
+        /// <summary>
+        /// "Each player can choose their preferred difficulty, ruleset and mods."
+        /// </summary>
+        public static LocalisableString FreestyleButtonTooltip => new TranslatableString(getKey(@"freestyle_button_tooltip"), @"Each player can choose their preferred difficulty, ruleset and mods.");
+
         private static string getKey(string key) => $@"{prefix}:{key}";
     }
 }

osu.Game/Online/Multiplayer/IMultiplayerClient.cs

@@ -95,6 +95,14 @@ public interface IMultiplayerClient : IStatefulUserHubClient
         /// <param name="beatmapAvailability">The new beatmap availability state of the user.</param>
         Task UserBeatmapAvailabilityChanged(int userId, BeatmapAvailability beatmapAvailability);
 
+        /// <summary>
+        /// Signals that a user in this room changed their style.
+        /// </summary>
+        /// <param name="userId">The ID of the user whose style changed.</param>
+        /// <param name="beatmapId">The user's beatmap.</param>
+        /// <param name="rulesetId">The user's ruleset.</param>
+        Task UserStyleChanged(int userId, int? beatmapId, int? rulesetId);
+
         /// <summary>
         /// Signals that a user in this room changed their local mods.
         /// </summary>

osu.Game/Online/Multiplayer/IMultiplayerRoomServer.cs

@@ -57,6 +57,13 @@ public interface IMultiplayerRoomServer
         /// <param name="newBeatmapAvailability">The proposed new beatmap availability state.</param>
         Task ChangeBeatmapAvailability(BeatmapAvailability newBeatmapAvailability);
 
+        /// <summary>
+        /// Change the local user's style in the currently joined room.
+        /// </summary>
+        /// <param name="beatmapId">The beatmap.</param>
+        /// <param name="rulesetId">The ruleset.</param>
+        Task ChangeUserStyle(int? beatmapId, int? rulesetId);
+
         /// <summary>
         /// Change the local user's mods in the currently joined room.
         /// </summary>

osu.Game/Online/Multiplayer/MultiplayerClient.cs

@@ -358,6 +358,8 @@ public async Task ToggleSpectate()
 
         public abstract Task DisconnectInternal();
 
+        public abstract Task ChangeUserStyle(int? beatmapId, int? rulesetId);
+
         /// <summary>
         /// Change the local user's mods in the currently joined room.
         /// </summary>
@@ -653,6 +655,25 @@ Task IMultiplayerClient.UserBeatmapAvailabilityChanged(int userId, BeatmapAvaila
             return Task.CompletedTask;
         }
 
+        public Task UserStyleChanged(int userId, int? beatmapId, int? rulesetId)
+        {
+            Scheduler.Add(() =>
+            {
+                var user = Room?.Users.SingleOrDefault(u => u.UserID == userId);
+
+                // errors here are not critical - user style is mostly for display.
+                if (user == null)
+                    return;
+
+                user.BeatmapId = beatmapId;
+                user.RulesetId = rulesetId;
+
+                RoomUpdated?.Invoke();
+            }, false);
+
+            return Task.CompletedTask;
+        }
+
         public Task UserModsChanged(int userId, IEnumerable<APIMod> mods)
         {
             Scheduler.Add(() =>

osu.Game/Online/Multiplayer/MultiplayerRoomUser.cs

@@ -22,9 +22,6 @@ public class MultiplayerRoomUser : IEquatable<MultiplayerRoomUser>
         [Key(1)]
         public MultiplayerUserState State { get; set; } = MultiplayerUserState.Idle;
 
-        [Key(4)]
-        public MatchUserState? MatchState { get; set; }
-
         /// <summary>
         /// The availability state of the current beatmap.
         /// </summary>
@@ -37,6 +34,21 @@ public class MultiplayerRoomUser : IEquatable<MultiplayerRoomUser>
         [Key(3)]
         public IEnumerable<APIMod> Mods { get; set; } = Enumerable.Empty<APIMod>();
 
+        [Key(4)]
+        public MatchUserState? MatchState { get; set; }
+
+        /// <summary>
+        /// If not-null, a local override for this user's ruleset selection.
+        /// </summary>
+        [Key(5)]
+        public int? RulesetId;
+
+        /// <summary>
+        /// If not-null, a local override for this user's beatmap selection.
+        /// </summary>
+        [Key(6)]
+        public int? BeatmapId;
+
         [IgnoreMember]
         public APIUser? User { get; set; }
 

osu.Game/Online/Multiplayer/OnlineMultiplayerClient.cs

@@ -60,6 +60,7 @@ private void load(IAPIProvider api)
                     connection.On(nameof(IMultiplayerClient.GameplayStarted), ((IMultiplayerClient)this).GameplayStarted);
                     connection.On<GameplayAbortReason>(nameof(IMultiplayerClient.GameplayAborted), ((IMultiplayerClient)this).GameplayAborted);
                     connection.On(nameof(IMultiplayerClient.ResultsReady), ((IMultiplayerClient)this).ResultsReady);
+                    connection.On<int, int?, int?>(nameof(IMultiplayerClient.UserStyleChanged), ((IMultiplayerClient)this).UserStyleChanged);
                     connection.On<int, IEnumerable<APIMod>>(nameof(IMultiplayerClient.UserModsChanged), ((IMultiplayerClient)this).UserModsChanged);
                     connection.On<int, BeatmapAvailability>(nameof(IMultiplayerClient.UserBeatmapAvailabilityChanged), ((IMultiplayerClient)this).UserBeatmapAvailabilityChanged);
                     connection.On<MatchRoomState>(nameof(IMultiplayerClient.MatchRoomStateChanged), ((IMultiplayerClient)this).MatchRoomStateChanged);
@@ -186,6 +187,16 @@ public override Task ChangeBeatmapAvailability(BeatmapAvailability newBeatmapAva
             return connection.InvokeAsync(nameof(IMultiplayerServer.ChangeBeatmapAvailability), newBeatmapAvailability);
         }
 
+        public override Task ChangeUserStyle(int? beatmapId, int? rulesetId)
+        {
+            if (!IsConnected.Value)
+                return Task.CompletedTask;
+
+            Debug.Assert(connection != null);
+
+            return connection.InvokeAsync(nameof(IMultiplayerServer.ChangeUserStyle), beatmapId, rulesetId);
+        }
+
         public override Task ChangeUserMods(IEnumerable<APIMod> newMods)
         {
             if (!IsConnected.Value)

osu.Game/Online/Rooms/CreateRoomScoreRequest.cs

@@ -31,6 +31,7 @@ protected override WebRequest CreateWebRequest()
             var req = base.CreateWebRequest();
             req.Method = HttpMethod.Post;
             req.AddParameter("version_hash", versionHash);
+            req.AddParameter("beatmap_id", beatmapInfo.OnlineID.ToString(CultureInfo.InvariantCulture));
             req.AddParameter("beatmap_hash", beatmapInfo.MD5Hash);
             req.AddParameter("ruleset_id", rulesetId.ToString(CultureInfo.InvariantCulture));
             return req;

osu.Game/Online/Rooms/MultiplayerPlaylistItem.cs

@@ -56,6 +56,12 @@ public class MultiplayerPlaylistItem
         [Key(10)]
         public double StarRating { get; set; }
 
+        /// <summary>
+        /// Indicates whether participants in the room are able to pick their own choice of beatmap difficulty and ruleset.
+        /// </summary>
+        [Key(11)]
+        public bool Freestyle { get; set; }
+
         [SerializationConstructor]
         public MultiplayerPlaylistItem()
         {

osu.Game/Online/Rooms/MultiplayerScore.cs

@@ -77,11 +77,14 @@ public class MultiplayerScore
         [CanBeNull]
         public MultiplayerScoresAround ScoresAround { get; set; }
 
-        public ScoreInfo CreateScoreInfo(ScoreManager scoreManager, RulesetStore rulesets, PlaylistItem playlistItem, [NotNull] BeatmapInfo beatmap)
+        [JsonProperty("ruleset_id")]
+        public int RulesetId { get; set; }
+
+        public ScoreInfo CreateScoreInfo(ScoreManager scoreManager, RulesetStore rulesets, [NotNull] BeatmapInfo beatmap)
         {
-            var ruleset = rulesets.GetRuleset(playlistItem.RulesetID);
+            var ruleset = rulesets.GetRuleset(RulesetId);
             if (ruleset == null)
-                throw new InvalidOperationException($"Couldn't create score with unknown ruleset: {playlistItem.RulesetID}");
+                throw new InvalidOperationException($"Couldn't create score with unknown ruleset: {RulesetId}");
 
             var rulesetInstance = ruleset.CreateInstance();
 
@@ -91,7 +94,7 @@ public ScoreInfo CreateScoreInfo(ScoreManager scoreManager, RulesetStore ruleset
                 TotalScore = TotalScore,
                 MaxCombo = MaxCombo,
                 BeatmapInfo = beatmap,
-                Ruleset = rulesets.GetRuleset(playlistItem.RulesetID) ?? throw new InvalidOperationException($"Ruleset with ID of {playlistItem.RulesetID} not found locally"),
+                Ruleset = ruleset,
                 Passed = Passed,
                 Statistics = Statistics,
                 MaximumStatistics = MaximumStatistics,

osu.Game/Online/Rooms/PlaylistItem.cs

@@ -67,6 +67,12 @@ private int onlineBeatmapId
             set => Beatmap = new APIBeatmap { OnlineID = value };
         }
 
+        /// <summary>
+        /// Indicates whether participants in the room are able to pick their own choice of beatmap difficulty and ruleset.
+        /// </summary>
+        [JsonProperty("freestyle")]
+        public bool Freestyle { get; set; }
+
         /// <summary>
         /// A beatmap representing this playlist item.
         /// In many cases, this will *not* contain any usable information apart from OnlineID.
@@ -101,6 +107,7 @@ public PlaylistItem(MultiplayerPlaylistItem item)
             PlayedAt = item.PlayedAt;
             RequiredMods = item.RequiredMods.ToArray();
             AllowedMods = item.AllowedMods.ToArray();
+            Freestyle = item.Freestyle;
         }
 
         public void MarkInvalid() => valid.Value = false;
@@ -120,18 +127,19 @@ public PlaylistItem(MultiplayerPlaylistItem item)
 
         #endregion
 
-        public PlaylistItem With(Optional<long> id = default, Optional<IBeatmapInfo> beatmap = default, Optional<ushort?> playlistOrder = default)
+        public PlaylistItem With(Optional<long> id = default, Optional<IBeatmapInfo> beatmap = default, Optional<ushort?> playlistOrder = default, Optional<int> ruleset = default)
         {
             return new PlaylistItem(beatmap.GetOr(Beatmap))
             {
                 ID = id.GetOr(ID),
                 OwnerID = OwnerID,
-                RulesetID = RulesetID,
+                RulesetID = ruleset.GetOr(RulesetID),
                 Expired = Expired,
                 PlaylistOrder = playlistOrder.GetOr(PlaylistOrder),
                 PlayedAt = PlayedAt,
                 AllowedMods = AllowedMods,
                 RequiredMods = RequiredMods,
+                Freestyle = Freestyle,
                 valid = { Value = Valid.Value },
             };
         }
@@ -143,6 +151,7 @@ public bool Equals(PlaylistItem? other)
                && Expired == other.Expired
                && PlaylistOrder == other.PlaylistOrder
                && AllowedMods.SequenceEqual(other.AllowedMods)
-               && RequiredMods.SequenceEqual(other.RequiredMods);
+               && RequiredMods.SequenceEqual(other.RequiredMods)
+               && Freestyle == other.Freestyle;
     }
 }

osu.Game/Screens/OnlinePlay/DailyChallenge/DailyChallenge.cs

@@ -161,7 +161,7 @@ private void load(AudioManager audio)
                             {
                                 new Drawable[]
                                 {
-                                    new DrawableRoomPlaylistItem(playlistItem)
+                                    new DrawableRoomPlaylistItem(playlistItem, true)
                                     {
                                         RelativeSizeAxes = Axes.X,
                                         AllowReordering = false,

osu.Game/Screens/OnlinePlay/DailyChallenge/DailyChallengeLeaderboard.cs

@@ -142,10 +142,10 @@ public void RefetchScores()
 
             request.Success += req => Schedule(() =>
             {
-                var best = req.Scores.Select(s => s.CreateScoreInfo(scoreManager, rulesets, playlistItem, beatmap.Value.BeatmapInfo)).ToArray();
+                var best = req.Scores.Select(s => s.CreateScoreInfo(scoreManager, rulesets, beatmap.Value.BeatmapInfo)).ToArray();
 
                 userBestScore.Value = req.UserScore;
-                var userBest = userBestScore.Value?.CreateScoreInfo(scoreManager, rulesets, playlistItem, beatmap.Value.BeatmapInfo);
+                var userBest = userBestScore.Value?.CreateScoreInfo(scoreManager, rulesets, beatmap.Value.BeatmapInfo);
 
                 cancellationTokenSource?.Cancel();
                 cancellationTokenSource = null;

osu.Game/Screens/OnlinePlay/DrawableRoomPlaylistItem.cs

@@ -74,7 +74,7 @@ public partial class DrawableRoomPlaylistItem : OsuRearrangeableListItem<Playlis
 
         public bool IsSelectedItem => SelectedItem.Value?.ID == Item.ID;
 
-        private readonly DelayedLoadWrapper onScreenLoader = new DelayedLoadWrapper(Empty) { RelativeSizeAxes = Axes.Both };
+        private readonly DelayedLoadWrapper onScreenLoader;
         private readonly IBindable<bool> valid = new Bindable<bool>();
 
         private IBeatmapInfo? beatmap;
@@ -120,9 +120,11 @@ public partial class DrawableRoomPlaylistItem : OsuRearrangeableListItem<Playlis
         [Resolved(CanBeNull = true)]
         private ManageCollectionsDialog? manageCollectionsDialog { get; set; }
 
-        public DrawableRoomPlaylistItem(PlaylistItem item)
+        public DrawableRoomPlaylistItem(PlaylistItem item, bool loadImmediately = false)
             : base(item)
         {
+            onScreenLoader = new DelayedLoadWrapper(Empty, timeBeforeLoad: loadImmediately ? 0 : 500) { RelativeSizeAxes = Axes.Both };
+
             Item = item;
 
             valid.BindTo(item.Valid);